API Blueprint | API Blueprint
API Blueprint. Un potente lenguaje de descripción de APIs de alto nivel para APIs web.
API Blueprint es simple y accesible para todos los involucrados en el ciclo de vida de la API. Su sintaxis es concisa pero expresiva. Con API Blueprint puede diseñar rápidamente y crear prototipos de APIs o documentar y probar APIs de misión crítica ya desplegadas.
Sección de Herramientas Tutoriales
# GET /message+ Response 200 (text/plain) Hello World!Centrado en la Colaboración
API Blueprint está construido para fomentar el diálogo y la colaboración entre las partes interesadas del proyecto, los desarrolladores y los clientes en cualquier punto del ciclo de vida de la API. Al mismo tiempo, las herramientas de API Blueprint proporcionan el apoyo necesario para alcanzar los objetivos, ya sea el desarrollo, la gobernanza o la entrega de la API.
Abierto
API Blueprint es completamente de código abierto bajo la licencia MIT.Su futuro es transparente y abierto.API Blueprint no necesita un grupo de trabajo cerrado. En su lugar, utiliza el proceso RFC similar al lenguaje Rust o a los procesos RFC de Django Enhancement Proposal.
Para contribuir, envía una propuesta al repositorio RFC de API Blueprint.
En casa en GitHub
El lenguaje API Blueprint es reconocido por GitHub.Busca API Blueprint en GitHub usando la consultalanguage:"API Blueprint".
El tipo de medio para API Blueprint es text/vnd.apiblueprint, y la extensión de archivo estándar es .apib. Si utilizas esta extensión tusblueprints en GitHub tendrán la sintaxis resaltada.
Construido para mejores diseños de API
API Blueprint está construido para fomentar mejores diseños de API a través de la abstracción.El objetivo de API Blueprint es desacoplar los elementos de la API para permitir la modularidad mientras se encapsula el comportamiento de la implementación del backend.
Por ejemplo, modele sus datos primero utilizando la sintaxis de descripción de datos.
# Data Structures## Blog Post (object)+ id: 42 (number, required)+ text: Hello World (string)+ author (Author) - Author of the blog post.## Author (object)+ name: Boba Fett+ email: [email protected]Luego, utilice y reutilice los datos en sus puntos finales de la API.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)El diseño primero
API Blueprint se basa en la filosofía del diseño primero. Al igual que las pruebas de desarrollo impulsado por el intestino, API Blueprint representa un contrato para una API.Discutir su API y establecer el contrato antes de que se desarrolle tiende a conducir a mejores diseños de API.
Una vez que su API Blueprint está en su lugar todo el mundo puede probar si theimplementation está a la altura de las expectativas establecidas en el contrato.
Herramientas increíbles
Gracias a su amplia adopción existe una plétora de herramientas construidas para API Blueprint.Desde varias herramientas independientes como el servidor de simulación, la documentación y las herramientas de prueba hasta soluciones completas para el ciclo de vida de la API.
Vea la sección de herramientas para la lista.
Cómo empezar
Para empezar con API Blueprint necesitará un editor de texto plano. Para obtener la mejor experiencia de edición, cambie el resaltado de sintaxis a Markdown o directamente a API Blueprint (si su editor lo admite).
Con el editor listo, siga el tutorial de API Blueprint.
Una vez que haya escrito su primer API Blueprint, puede discutir el diseño de la API con sus amigos y utilizar las herramientas de API Blueprint. Por ejemplo, para generar documentación, generar un simulacro de su servicio o comenzar a probar su implementación de backend.