Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adotar ferramenta de documentação de contrato da API #17

Closed
yrachid opened this issue Oct 17, 2016 · 1 comment
Closed

Adotar ferramenta de documentação de contrato da API #17

yrachid opened this issue Oct 17, 2016 · 1 comment

Comments

@yrachid
Copy link
Contributor

yrachid commented Oct 17, 2016

Contexto

Existem algumas linguagens e ferramentas que ajudam na documentação e padronização de APIs. A ApiBlueprint, por exemplo, é uma linguagem que provê uma forma similar ao Markdown para escrever documentação. Existe um pequeno ecossistema de ferramentas em torno deste padrão, desde plataformas colaborativas para centralização de informações, como o Apiary até executores de teste de contrato, que analisam a resposta da aplicação contra a especificação do ApiBlueprint. Ferramentas como Aglio e Dredd, por exemplo, adicionariam ao projeto, respectivamente, um gerador de documentação para os endpoints escritos em ApiBlueprint e testes de Contrato baseados na nossa Blueprint.

@josigama
Copy link
Contributor

história duplicada #18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants