Integrate REST API specs (OpenAPI/Swagger)

questionpy-org / questionpy-docs

0 stars 0 forks source link

Integrate REST API specs (OpenAPI/Swagger) #3

Open tumidi opened 6 months ago

tumidi commented 6 months ago

Plugin candidates:

https://www.neoteroi.dev/mkdocs-plugins/web/oad/
https://github.com/bharel/mkdocs-render-swagger-plugin
https://github.com/blueswen/mkdocs-swagger-ui-tag
https://github.com/vrerv/mkdocs-openapi-markdown-plugin

tumidi commented 3 months ago

Habe verschiedene der Plugins ausprobiert, wobei Neoteroi/mkdocs-plugins noch das vielversprechendste ist. Leider haben die Plugins alle irgendwelche Fehler bzw. Probleme OpenAPI-Dateien zu verarbeiten, die sich gegenseitig verlinken:

# qppe-lms.yaml
  /package/{package_hash}:
    parameters:
      - $ref: 'qppe-server.yaml#/components/parameters/PackageHash'