swagger-api / swagger-api/swagger-codegen
Continuous Integration of client SDKs
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
As soon as my swagger definition is up & running, I would like to have a continuos integration with my backend in order to update the swagger definition in the backend, and generate the sdk clients automatically like
| Backend (Node) | ---(diff/write)---> | Swagger def | --(autogen) --> | client sdk |
So, as soon as there is a modification in the api definition, we should diff with the current definition, apply changes, and perform the auto gen of the automated clients.
Using the swagger-parser in node, I can parse the swagger file, and validate it, and that's ok, but I cannot edit/diff etc. respecting the model definition i.e. via module api. The swagger-node module, used by swagger-editor, has additional functionalities, but I don't see how to implement each modules of the continuos integration of the swagger api from the existing node backend (and maybe legacy), to the autogen.
Could you provide some info about this process for node?
Thank you.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked Swagger definition, the Node backend, swagger-parser, swagger-node, and the musixmatch-sdk repository. Determine how the definition is produced and how client generation currently runs; done would require a decided, documented continuous-integration process that diffs or updates the definition and regenerates clients.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- api, backend, ci-cd
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100