Skip to content

Swagger-specifications for geography #976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrsimpson wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Swagger-specifications for geography #976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
655456c
WIP: Geographies API swager
mrsimpson Mar 31, 2022
5ed31bb
WIP: Add basic geography examples
mrsimpson Apr 1, 2022
6e8326b
WIP: Initial geographies swagger spec
mrsimpson Apr 1, 2022
691d83a
WIP: Geographies mock server
mrsimpson Apr 1, 2022
32f0a1b
Add errors to geography API swagger
mrsimpson Apr 9, 2022
60c17a6
Merge branch 'develop' into policy-swagger
mrsimpson Apr 9, 2022
71db375
Update package.json
mrsimpson Apr 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/mds-geography-api/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"_build": "tsc --build tsconfig.build.json",
"_test": "PATH_PREFIX=/geography jest --runInBand",
"build": "pnpm _build",
"mock": "prism mock spec/spec.yaml -p 7011",
"start": "PATH_PREFIX=/geography pnpm watch server",
"test": "pnpm _test",
"ts-node": "pnpm build && ts-node -r ../../dotenv-flow.js",
Expand All @@ -27,7 +28,8 @@
"express": "4.17.1"
},
"devDependencies": {
"@mds-core/mds-test-data": "workspace:0.4.32"
"@mds-core/mds-test-data": "workspace:0.4.32",
"@stoplight/prism-cli": "4.8.0"
},
"publishConfig": {
"main": "dist/index.js"
Expand Down
17 changes: 17 additions & 0 deletions packages/mds-geography-api/spec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# API specification

The MDS geography API provides an OMF compliant implementation of [`/geographies` in version 1.0](https://github.com/openmobilityfoundation/mobility-data-specification/tree/release-1.0.0/policy#geographies)

_Remark: After 1.0, `/geographies` has been moved to an own specification with a slightly different format. This is not supported by the current implementation_

## Mocking

This package features [Primsm](https://github.com/stoplightio/prism) to provide a mocking server based on the examples included in the specification.
Run it with `pnpm mock`

Plase see the [mocking documentation](https://github.com/stoplightio/prism/blob/master/docs/guides/01-mocking.md#response-generation) for instructions how to retrieve a dedicated example, e. g.

```bash
curl http://localhost:7011/geographies/10000000-0000-0000-0000-000000000001 \
-H "Prefer: example=HistoricRome"
```
Loading