API Blueprint | API Blueprint
API Blueprint. Uma poderosa linguagem de descrição da API de alto nível para APIs web.
API Blueprint é simples e acessível a todos os envolvidos no ciclo de vida da API. Sua sintaxe é concisa, porém expressiva. Com o API Blueprint você pode rapidamente projetar e criar protótipos de APIs ou documentar e testar APIs já implantadas de missão crítica.
Secção de Ferramentas tutoriais
# GET /message+ Response 200 (text/plain) Hello World!Focused on Collaboration
API Blueprint é construído para encorajar o diálogo e a colaboração entre os interessados no projeto, desenvolvedores e clientes em qualquer ponto do ciclo APIlifecycle. Ao mesmo tempo, as ferramentas do API Blueprint fornecem o suporte para atingir os objetivos seja o desenvolvimento, a governança ou a entrega da API.
Abrir
API Blueprint é completamente aberto sob a licença do MIT. Ao invés disso, ele usa o processo RFC similar à linguagem Rust ou processos RFC Django Enhancement Proposal.
Para contribuir, envie uma proposta para o repositório RFC da API Blueprint.
Em casa no GitHub
A linguagem API Blueprint é reconhecida pelo GitHub.Search for API Blueprint on GitHub usando a consultalanguage:"API Blueprint".
O tipo de mídia para API Blueprint é text/vnd.apiblueprint, e a extensão do arquivo thestandard é .apib. Se você usar esta extensão, suas impressões em azul no GitHub serão iluminadas por sintaxe.
Built for better API Designs
API Blueprint é construído para encorajar melhores designs de API através da abstração. O objetivo do API Blueprint é desacoplar elementos da API para permitir a modularidade enquanto encapsula o comportamento da implementação backend.
Por exemplo, modele seus dados primeiro usando a sintaxe de descrição dos dados.
# 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]Então, use e reutilize os dados em seus pontos finais da API.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint é tudo sobre a filosofia design-first. Similar aos testes de desenvolvimento orientado a testes, API Blueprint representa um contrato para uma API. Discutir a sua API e estabelecer-se no contrato antes de ser desenvolvido tende a conduzir a melhores designs API.
A partir do momento que a sua API Blueprint está no lugar, todos podem testar se a implementação está a cumprir com as expectativas estabelecidas no contrato.
Ferramentas fantásticas
Pelas suas abrangentes adopções existe uma infinidade de ferramentas construídas para o API Blueprint. Desde várias ferramentas autónomas tais como mock server, documentação e ferramentas de teste até soluções completas de ciclo de vida API.
Veja a seção Ferramentas da lista.
Começando
Para começar com o API Blueprint você vai precisar de um editor de texto simples. Para a melhor experiência de edição mude a sintaxe para Markdown ou diretamente para API Blueprint (se suportado pelo seu editor).
Com o editor pronto, siga o tutorial da API Blueprint.
Após você ter escrito sua primeira API Blueprint você pode discutir a API designada com amigos e usar as ferramentas para API Blueprint. Por exemplo, para renderizar documentação, gerar um mock do seu serviço ou começar a testar a implementação do yourbackend.