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.

Sign up for GitHub

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

Jump to bottom

Documentação da API utilizando OpenAPI/Swagger #30

Open

guilhermeadc opened this issue Sep 12, 2022 · 1 comment

Labels

Contributor

guilhermeadc commented Sep 12, 2022

Necessário documentação de toda a API de serviços disponível no módulo através do projeto Swagger, contendo entre outros:

Descrição do recurso e seus campos
Exemplo de utilização dos serviços
Orientação sobre regras de negócio relacionadas
Descrição dos efeitos gerados no sistema com a sua utilização.

guilhermeadc added the enhancement label

Member

caduvieira commented Sep 13, 2022

Poderia ser usando anotações como o https://zircote.github.io/swagger-php/?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment