Jump to content
Bbruno

Documentação API

Recommended Posts

Bbruno

Bom dia,

tenho uma API desenvolvida por mim e estou à procura de alguma ferramenta tipo Dashboard onde eu consiga
gerar a documentação da mesma, por exemplo indicar que parametros são obrigatórios e exemplos de pedido e resposta a API aceita.
Procurei na internet mas existe muita coisa mas o que encontrei obriga mais a que se faça a API dentro da ferramenta deles e não é isso que pretendo, eu pretendo escrever os campos que a API necessita e colocar uma descrição sobre esses campos e colocar exemplos de funcionamento, se houvesse uma área onde os consumidores dessa API pudessem colocar questões seria perfeito.
Alguem sabe de algo desde género que eu consiga depois alterar para se adaptar ao que pretendo?

Obrigado
Bruno

Share this post


Link to post
Share on other sites
laboss

Boas eu uso o ReDoc ou o Swagger

 

https://github.com/Rebilly/ReDoc

https://swagger.io/tools/swagger-ui/

Share this post


Link to post
Share on other sites
HappyHippyHippo

swagger foi adoptado pela openapi e passou a ser a versão 3.0 desta

Edited by HappyHippyHippo

IRC : sim, é algo que ainda existe >> #p@p

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

×
×
  • Create New...

Important Information

By using this site you accept our Terms of Use and Privacy Policy. We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.