https://github.com/ioggstream/python-api-test
A simple python API for a TDD Course
https://github.com/ioggstream/python-api-test
openapi
Last synced: 11 months ago
JSON representation
A simple python API for a TDD Course
- Host: GitHub
- URL: https://github.com/ioggstream/python-api-test
- Owner: ioggstream
- License: agpl-3.0
- Created: 2020-08-20T14:08:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-28T21:41:15.000Z (over 5 years ago)
- Last Synced: 2025-01-27T06:12:49.726Z (about 1 year ago)
- Topics: openapi
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Starter kit per la pubblicazione di API interoperabili in Python
[](https://circleci.com/gh/teamdigitale/api-starter-kit-python)
[](https://developersitalia.slack.com/messages/CDKBYTG74)
[](https://slack.developers.italia.it/)
[](https://forum.italia.it/c/interoperabilita)
Questo repository contiene il template di un'API interoperabile scritta in Python.
## Contenuto
- Un progetto di esempio con python e connexion senza la generazione di codice
- Una directory `openapi` con le specifiche
## Istruzioni
Gli step per la creazione di API interoperabili sono:
1. scrivere le specifiche in formato OpenAPI v3 partendo dagli esempi in `openapi`;
2. scrivere i metodi dell'applicazione
### Scrivere le specifiche
Le specifiche devono essere scritte in formato OpenAPIv3
e rispettando le [Linee Guida di interoperabilità](https://docs.italia.it/italia/piano-triennale-ict/lg-modellointeroperabilita-docs).
Queste presentazioni possono essere d'aiuto:
- [Introduzione ad OpenAPI](https://docs.google.com/presentation/d/1blql0E_zcbq7r-wzmslgJPiW7ELkYlIn9_fqIVEXr4A)
- [REST nel nuovo modello di interoperabilità](https://docs.google.com/presentation/u/1/d/1L6R4ZKhLoZAPEmai1KSED1nrq0GNrx3-TU53sGhfrO8/)
### Risolvere le dipendenze negli OpenAPI
Le specifiche OpenAPI possono contenere riferimenti a schemi esterni
o [yaml anchors](). E' possibile risolverli tramite il modulo python
`openapi_resolver`, richamato dal `Makefile`.
In questo repository, i file con anchor e ref hanno estensione `.yaml.src`
ma sono a tutti gli effetti file OAS3 validi e la maggior parte dei
tool li interpreta correttamente. E' comunque possibile dereferenziarli
per comodità tramite il comando:
make yaml
### Dipendenze
Per eseguire questa app servono:
```
make
python 3 + tox
docker
```
### Test con docker
Questo comando lancia tutti i container necessari ed esegue i test:
```
docker-compose up test
```
### Test con circleci
E' possibile testare in locale tramite circleci, con:
circleci build