Comment Comment by crypteasy My company is currently trialing this with the Open API Spec. The workflow at a high level:1) Make code changes to a specific microservice. (note: The Open API Spec also lives in code.)2) CI/CD pipelines get triggered.3) New microservice is built.4) Call every REST endpoint defined in the microservice's Open API Spec and validate it using the example requests/responses.5) If successful, regenerate the API documentation from the Open API Spec.This ensures that our documentation and services will stay inline with each other. parent crypteasy 5 years ago
1) Make code changes to a specific microservice. (note: The Open API Spec also lives in code.)
2) CI/CD pipelines get triggered.
3) New microservice is built.
4) Call every REST endpoint defined in the microservice's Open API Spec and validate it using the example requests/responses.
5) If successful, regenerate the API documentation from the Open API Spec.
This ensures that our documentation and services will stay inline with each other.