{"id":15286118,"url":"https://github.com/readmeio/openapi-workshop","last_synced_at":"2025-10-07T01:30:31.272Z","repository":{"id":42627881,"uuid":"269470546","full_name":"readmeio/openapi-workshop","owner":"readmeio","description":null,"archived":true,"fork":false,"pushed_at":"2023-10-07T18:43:11.000Z","size":768,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-01-19T03:17:39.038Z","etag":null,"topics":["openapi","swagger"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readmeio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-04T21:36:46.000Z","updated_at":"2024-05-23T19:51:25.000Z","dependencies_parsed_at":"2024-09-30T15:21:27.372Z","dependency_job_id":null,"html_url":"https://github.com/readmeio/openapi-workshop","commit_stats":{"total_commits":47,"total_committers":7,"mean_commits":6.714285714285714,"dds":0.3829787234042553,"last_synced_commit":"6c22f17bc41a1de378d715aa2a64b7123c92cc96"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readmeio%2Fopenapi-workshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readmeio%2Fopenapi-workshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readmeio%2Fopenapi-workshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readmeio%2Fopenapi-workshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readmeio","download_url":"https://codeload.github.com/readmeio/openapi-workshop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235569498,"owners_count":19011184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","swagger"],"created_at":"2024-09-30T15:10:34.069Z","updated_at":"2025-10-07T01:30:30.900Z","avatar_url":"https://github.com/readmeio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![](https://raw.githubusercontent.com/readmeio/.github/main/oss-header.png)](https://readme.com)\n\n# OpenAPI Workshop\n\n![OpenAPI Workshop](./preview.png)\n\n[![NPM version][npm-image]][npm-url]\n[![node][node-image]][node-url]\n[![repo][ci-image]][repo-url]\n\n**✨ Learn how to use the OpenAPI Specification the easy way! ✨**\n\n\u003e **OAS** is a specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful web services\n\u003e\n\u003e — about [OpenAPI] at **Wikipedia**\n\n## Exercises\n\nThis workshopper has easy and clear tasks that cover the most important aspects of OAS.\n\n* **Basic Structure** — Overview of the skeletal structure of OAS\n* **POST Endpoints** — Learn how to define a POST endpoint\n* **POST requestBody** — Learn about the POST requestBody structure\n* **POST response** — Learn about the POST response\n* **GET Endpoints** — Learn how to define a GET endpoint\n* **$ref** — Learn how to use `$ref` in OAS\n* **Server Variables** — Build dynamic URLs for your API with Server Variables\n* **anyOf, allOf** — Build complex schemas with `anyOf` and `allOf`\n\n\n## Requirements\n\nIf you are on Windows, make sure you are using at least version 12 of Node.js\n\n* [**Node.js**](node-url) ^12 || ^14 || ^16\n\n## Installation\n\nOpen your terminal and run this command:\n\n    npm install -g openapi-workshop\n\n## Usage\n\nOpen your terminal and run the following command:\n\n    openapi-workshop\n\n## License\n\nMIT © [ReadMe](https://readme.com)\n\n\u003c!-- References --\u003e\n\n[node-url]: https://nodejs.org/en/\n[npm-url]: https://npmjs.org/package/openapi-workshop\n[OpenAPI]: https://en.wikipedia.org/wiki/OpenAPI_Specification\n[repo-url]: https://github.com/readmeio/openapi-workshop\n\n\u003c!-- Badges --\u003e\n\n[ci-image]: https://img.shields.io/github/actions/workflow/status/readmeio/openapi-workshop/ci.yml?branch=main\u0026style=flat-square\n[node-image]: https://img.shields.io/node/v/openapi-workshop.svg?style=flat-square\n[npm-image]: https://img.shields.io/npm/v/openapi-workshop.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadmeio%2Fopenapi-workshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadmeio%2Fopenapi-workshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadmeio%2Fopenapi-workshop/lists"}