OAI / learn.openapis.org

OpenAPI - Getting started, and the specification explained
https://learn.openapis.org/
Creative Commons Attribution 4.0 International
108 stars 51 forks source link

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

Open SensibleWood opened 4 months ago

SensibleWood commented 4 months ago

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 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 commented 4 months ago

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 commented 3 months ago