t-huyeng / api-doc-template

[DE]/[EN]

[TEMPLATE]

Quickstart

• Add openAPI spec in German to openapi.yml
• Add openAPI spec in English to openapi_en.yml (or remove openapi_en.yml )
• Update index.html (insert the API-name in the title)
• Update generator_config.yaml (Update all values surrounded with <>)
• Update the url in CNAME once the api has its own subdomain
• Replace the content of README.md with a German description of the API
• Fill (or remove) README_en.md or add README-files in other languages.

Add Library to deutschland package

Fork the deutschland package:

1. In the pyproject.toml of the deutschland-package add a entry in the dependency section. The values for <NAME> and <VERSION> must match with the values in generator_config.yaml For Example:

   de-`<NAME>` = {version= "^`<VERSION>`", optional = true}

2. Under the [tool.poetry.extras] section add the following <NAME>` =["de-`<NAME>`"]

   Also add de-name in the all list:

    all = ["de-bundestag-lobbyregister","de-dip-bundestag","de-pegel-online","de-ausbildungssuche",
    "de-berufssprachkurssuche","de-coachingangebote","de-dip-bundestag","de-entgeltatlas",
    "de-hochwasserzentralen","de-pflanzenschutzmittelzulassung","de-studiensuche",
    "de-tagesschau", "de-weiterbildungssuche","de-feiertage",...,"de-`<NAME>`"]

3. Add apis into test_imports.py

   from deutschland.<NAME>.apis import DefaultApi
   

4. Open a merge request.