[MVP] Implementação prática de OpenAPI para gerar documentação interativa

[fititnt]

Links rápidos:

• OpenAPI
  • https://openapi-generator.tech/
  • https://github.com/OpenAPITools/openapi-generator
• Pontos de questão relacionados:
  • [MVP] UN/OCHA CODv2 API, documentação em Inglês [MVP] UN/OCHA CODv2 API, documentação em Inglês #1
  • [MVP] HXLStandard HXL-Proxy, documentação em Português [MVP] HXLStandard HXL-Proxy, documentação em Português #3
  • [MVP] UN/OCHA HDX ("Humanitarian Data Exchange") API, documentação em Português [MVP] UN/OCHA HDX ("Humanitarian Data Exchange") API, documentação em Português #2
  • [MVP] Portais de dados abertos (CKAN) no Brasil, documentação em Português [MVP] Portais de dados abertos (CKAN) no Brasil, documentação em Português #4

---

Tópico sobre Produto Mínimo Viável (em inglês: MVP) implementação prática de OpenAPI para gerar documentação interativa.

---

Geradores suportados pelo openapi-generator-cli

fititnt@bravo:/workspace/git/HXL-CPLP/Auxilium-Humanitarium-API$ openapi-generator-cli version
5.1.1
fititnt@bravo:/workspace/git/HXL-CPLP/Auxilium-Humanitarium-API$ openapi-generator-cli list
The following generators are available:

CLIENT generators:
    - ada
    - android
    - apex
    - bash
    - c
    - clojure
    - cpp-qt5-client
    - cpp-restsdk
    - cpp-tizen
    - cpp-ue4 (beta)
    - crystal (beta)
    - csharp
    - csharp-netcore
    - dart
    - dart-dio
    - dart-dio-next (experimental)
    - dart-jaguar
    - eiffel
    - elixir
    - elm
    - erlang-client
    - erlang-proper
    - go
    - groovy
    - haskell-http-client
    - java
    - javascript
    - javascript-apollo (beta)
    - javascript-closure-angular
    - javascript-flowtyped
    - jaxrs-cxf-client
    - jmeter
    - k6 (beta)
    - kotlin
    - lua (beta)
    - nim (beta)
    - objc
    - ocaml
    - perl
    - php
    - powershell (beta)
    - python (experimental)
    - python-legacy
    - r
    - ruby
    - rust
    - scala-akka
    - scala-gatling
    - scala-sttp (beta)
    - scalaz
    - swift5 (beta)
    - typescript (experimental)
    - typescript-angular
    - typescript-aurelia
    - typescript-axios
    - typescript-fetch
    - typescript-inversify
    - typescript-jquery
    - typescript-nestjs (experimental)
    - typescript-node
    - typescript-redux-query
    - typescript-rxjs


SERVER generators:
    - ada-server
    - aspnetcore
    - cpp-pistache-server
    - cpp-qt5-qhttpengine-server
    - cpp-restbed-server
    - csharp-nancyfx
    - erlang-server
    - fsharp-functions (beta)
    - fsharp-giraffe-server (beta)
    - go-echo-server (beta)
    - go-gin-server
    - go-server
    - graphql-nodejs-express-server
    - haskell
    - java-inflector
    - java-msf4j
    - java-pkmst
    - java-play-framework
    - java-undertow-server
    - java-vertx-web (beta)
    - jaxrs-cxf
    - jaxrs-cxf-cdi
    - jaxrs-cxf-extended
    - jaxrs-jersey
    - jaxrs-resteasy
    - jaxrs-resteasy-eap
    - jaxrs-spec
    - kotlin-server
    - kotlin-spring
    - kotlin-vertx (beta)
    - nodejs-express-server (beta)
    - php-laravel
    - php-lumen
    - php-mezzio-ph
    - php-slim4
    - php-symfony
    - python-aiohttp
    - python-blueplanet
    - python-flask
    - ruby-on-rails
    - ruby-sinatra
    - rust-server
    - scala-akka-http-server (beta)
    - scala-finch
    - scala-lagom-server
    - scala-play-server
    - scalatra
    - spring


DOCUMENTATION generators:
    - asciidoc
    - cwiki
    - dynamic-html
    - html
    - html2
    - markdown (beta)
    - openapi
    - openapi-yaml
    - plantuml (beta)


SCHEMA generators:
    - avro-schema (beta)
    - graphql-schema
    - ktorm-schema (beta)
    - mysql-schema
    - protobuf-schema (beta)


CONFIG generators:
    - apache2

[fititnt]

Este ponto foi resolvido com ajuda do https://github.com/OpenAPITools/openapi-generator.

Já esta bom, só não está tão otimizado (as strings ainda são hardcoded por arquivo inteiro, não tem como reutilizar templates) quanto o que ja estamos conseguindo fazer com ajuda do :

• [MVP] Tema Jekyll em Boostrap 5 focado em internacionalização (isto é, permitir futura localização/tradução) para hapi.etica.ai [MVP] Tema Jekyll em Boostrap 5 focado em internacionalização (isto é, permitir futura localização/tradução) para hapi.etica.ai #9

Essa segunda otimização pode ser feita em um segundo momento, mas antes vamos resolver o Isso pode ser feito em um segundo momento, mas vamos resolver o

• Schemas de padrões de dados comum em troda de dados no contexto humanitário, foco em internacionalização/localização [MVP] Schemas de padrões de dados comum em troca de dados no contexto humanitário, foco em internacionalização/localização #7