Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create swagger/openAPI doc homepage #40

Open
4 tasks
srkirkland opened this issue Sep 14, 2021 · 0 comments
Open
4 tasks

Create swagger/openAPI doc homepage #40

srkirkland opened this issue Sep 14, 2021 · 0 comments
Assignees

Comments

@srkirkland
Copy link
Member

this app has a few API endpoint available from the index.ts file. Specifically we want to focus on the following endpoints.

  • POST: /initialProcessing
  • POST: /process
  • POST: /processDistance
  • POST: /processRoutes

Take a look at https://github.com/ucdavis/fuel-reduction-cost-simulator, which has swagger UI served from the homepage (https://fuel-reduction-cost-simulator.azurewebsites.net/). LCA package is another example: https://github.com/ucdavis/LCA.

We want to do the same thing, so when I do a GET against a running version of this backend, I see the swagger docs which describe all of the parameters and models for each of the above endpoints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants