https://github.com/fif0o/openapi-specs
POC for api specs driven development.
https://github.com/fif0o/openapi-specs
openapi typescript
Last synced: 8 months ago
JSON representation
POC for api specs driven development.
- Host: GitHub
- URL: https://github.com/fif0o/openapi-specs
- Owner: FiF0o
- Created: 2021-11-12T17:31:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-15T18:30:52.000Z (about 4 years ago)
- Last Synced: 2025-02-23T08:28:28.577Z (12 months ago)
- Topics: openapi, typescript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# POC
## Description
This package is a proof of concept to create modular openapi specs from design to deployment steps.
_Node 12+ is required._
## Workflow & Scripts
Assumption: development is design driven, technical design is defined then implemented. open api specification drives the development and acts as a single source of truth
```sh
# 1. Specification is defined by the team using an openapi3.x using a modular approach
# Something schema as $ref from main.yml
./openapi/main.yml
# 2. Specifications are received then implemented by the development team.
# Validate specs
npm run openapi:lint
# 3. Schemas from the openapi specs are derived and typescript interfaces created
# ./openapi/components/something.ts. something.yml > something.ts
npm run openapi:generate:interfaces
# 4. Deployment is done with IaC. One single file to be consumed for deployment as megaspec.yml
# ./dist/megaspec.yml
openapi:create
```