Skip to content

Melhor documentação e alinhamento com Swagger #61

@ppKrauss

Description

@ppKrauss

Atualmente nossos usuários e clientes concordaram em usar o padrão Swagger como principal ferramenta de apoio à documentação e à formalização descritiva da API e seus endpoints. É tudo gerado automaticamente pelo PostgREST. Ver por exemplo https://test.afa.codes/swagger

Ver maiores detalhes em https://github.com/osm-codes/swagger

Requisitos de documentação no WS:

  1. Criar parser de apoio para pelo menos destacar os endpoints PostgREST de https://github.com/osm-codes/WS/blob/main/src/config.nginx
  2. Retomar filosofia original de que tudo o todos os paths não-PHP em afa.codes/{path} sejam também paths em api.afa.codes/{path}
  3. Incluir descritores de valor default e de exemplos, ver https://swagger.io/docs/specification/v3_0/adding-examples/

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions