Skip to content

incluir HTML do Swagger #1

@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

O que falta é incluir o HTML do gerador de página Swagger aqui no git. Incluir na pasta src para não confundir com index Github.

Requisitos de modificação do HTML:

  • não fazemos propaganda de terceiros, trocar o logotipo pelo nosso (AddressForAll ou AFA Codes).
  • incluir link para a página de documentação, hoje https://wikifull.addressforall.org/doc/osmc:Swagger (posteriormente wiki publica)
  • chamar atenção que algumas coisas são parâmetros de função e outras são filtros PostgREST, sem isso fica muito confuso.

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions