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

Add a page cataloging a curated list of example OpenAPI documents #89

Open
SensibleWood opened this issue Mar 17, 2024 · 2 comments
Open

Comments

@SensibleWood
Copy link
Collaborator

SensibleWood commented Mar 17, 2024

This issue details a thread in Slack, namely: https://open-api.slack.com/archives/C0KM0KXU6/p1710321260049639

The Petstore API has long been used as the canonical example of an OpenAPI description, partly for reasons of history but also because alternatives comes from different sources that are not always readily apparent and not cataloged in a well-known location. There are many useful alternatives to Petstore - include the Tic Tac Toe example in this repository - that would provide different views of "what good looks like" in API design for the community.

A new page in this repository is therefore proposed to address this:

  • The page will provide a curated list of OpenAPI descriptions provided by the community.
  • Each will be listed with a brief explanation of the qualities it displays.
  • Each will be cataloged against a given version of OpenAPI (with cognizance of the fact the "same" description could appear multiple times, with each instance being at a given version).

The result should be a well-tended and useful list of OpenAPI descriptions that provides the community with multiple references to model APIs.

For the avoidance of doubt: These examples are provided as generic API descriptions that are used for educational purposes. They ARE NOT intended to be pointers to commercial APIs. Whilst OpenAPI members and vendors are encouraged to contribute to this list their submissions are not expected to point to their own APIs. There is a bunch of other stuff on the internet that can serve the purpose of providing references to commercial propositions.

@lornajane
Copy link
Collaborator

I'd like to contribute the Museum API to the list. It was created specifically for learning purposes, and while I expect us to add some more features and update it, I believe it is useful in its current form. It's here: https://github.com/Redocly/museum-openapi-example/blob/main/openapi.yaml

@philsturgeon
Copy link
Collaborator

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

3 participants