https://github.com/bundesapi/api-doc-template
https://github.com/bundesapi/api-doc-template
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bundesapi/api-doc-template
- Owner: bundesAPI
- Created: 2021-09-05T11:57:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T18:14:55.000Z (over 2 years ago)
- Last Synced: 2025-01-17T21:22:51.490Z (3 months ago)
- Language: HTML
- Size: 28.3 KB
- Stars: 4
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[[DE]](README.md)/[[EN]](README_en.md)
# [_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](https://github.com/bundesAPI/deutschland) package:
1. In the `pyproject.toml` of the [deutschland-package](https://github.com/bundesAPI/deutschland/blob/main/pyproject.toml) add a entry in the dependency section. The values for `` and `` must match with the values in `generator_config.yaml`
For Example:
```de-`` = {version= "^``", optional = true}```
2. Under the ```[tool.poetry.extras]``` section add the following
```` =["de-``"]```
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-``"]
```
3. Add apis into [test_imports.py](https://github.com/bundesAPI/deutschland/blob/main/tests/test_imports.py)
```
from deutschland..apis import DefaultApi
```
4. Open a [merge request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).