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 OpenAPI Spec for expo api [Public routes] #107

Open
eveninglily opened this issue Jul 1, 2019 · 2 comments
Open

Create OpenAPI Spec for expo api [Public routes] #107

eveninglily opened this issue Jul 1, 2019 · 2 comments

Comments

@eveninglily
Copy link
Member

OpenAPI is a way of documenting APIs that allows us to generate nice documentation and client libraries for the API. It'd be really great to have a spec for our backend.

Because overall, this is a big task, the scope of this issue is limited to the following two tasks:

  • Create a spec with all the basic meta information
  • Document the public endpoints (found in server.py)

See:

@thisistimothychen
Copy link
Contributor

Can use https://documenter.getpostman.com/view/1241148/RWaDVqx3?version=latest as a reference! Probably not most up to date, but has some good stuff

@eveninglily
Copy link
Member Author

Ooh, awesome to see that!

Based on https://blog.getpostman.com/2018/12/11/postman-supports-openapi-3-0/ it looks like you can import OpenAPI specs into Postman, not sure if we can export this existing documentation into it?

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

No branches or pull requests

3 participants