Generate and OpenAPI file for the OpenCage Geocoding API.
The main OpenAPI document is openapi.yaml and everything else is $ref'ed in from there, using the following folder structure.
├── components
│ ├── parameters
│ │ └── *.yaml
│ └── schemas
│ │ └── *.yaml
├── paths
│ ├── geojson.yaml
│ ├── json.yaml
│ └── xml.yaml
├── openapi.yaml
These split files are easier to work with and reduce repetition, but are harder to distribute. We can "bundle" the documents ot make single files, and those live in export/.
Using Redocly CLI you can bundle multiple documents into one, then share that document around easily.
redocly bundle openapi.yaml -o export/opencage-openapi-3.1.0.yaml# install spectral
npm install -g @stoplight/spectral-cli
# create a conf file
echo 'extends: ["spectral:oas"]' > .spectral.yaml
# run the linter
spectral lint opencage-openapi/export/opencage-openapi-3.1.2.yaml
See ratemyopenapi
to "publish" copy the file from export/ manually to the opencagedata-geocoder-app repo
into public/openapi.yaml