Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/Open-Sentencing-Aggregator

Generate swagger files from code

Open
#25 3 comments 0 reactions 3 assignees Claimed by @yochanah View on GitHub
aggregator ms-cohort-claimed
Dominant language
Java
Stars
8
Forks
18
PR merge metrics
No merged PRs in 30d

Description

The current code is autogenerated from the [swagger file](https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Aggregator/blob/main/src/main/resources/swagger.yaml). The team would like to switch this around so the swagger/OpenAPI spec is generated from the code. This is easier to manage for the team moving forward.

This [guide](https://openliberty.io/guides/microprofile-openapi.html#augmenting-the-existing-jax-rs-annotations-with-openapi-annotations) examples how to generate openAPI spec from Java code in open liberty.

Next steps
- [ ] create Java models and responses from the existing [swagger file](https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Aggregator/blob/main/src/main/resources/swagger.yaml).
- [ ] use the guide to add code to generate the swagger file from the Java code created in the step above.
- [ ] compare the old swagger file with the new swagger file to ensure nothing was changed.
- [ ] deploy the new project to the cloud.

FYI @joannhh @RickPoleshuck @sforsyth089

@yochanah this might affect the auth work you are doing. Have you already started that work? Do you want to wait till this is finished?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.