{"id":15091195,"url":"https://github.com/scottgriv/swagger-openapi-user_management_demo","last_synced_at":"2026-01-04T21:47:53.033Z","repository":{"id":221613520,"uuid":"754878197","full_name":"scottgriv/swagger-openapi-user_management_demo","owner":"scottgriv","description":"This demo project showcases the implementation of a User Management API documented with Swagger UI and defined using the OpenAPI Specification (OAS)","archived":false,"fork":false,"pushed_at":"2025-01-09T04:27:59.000Z","size":2932,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T21:09:34.868Z","etag":null,"topics":["api","oas","open-api","openapi","swagger"],"latest_commit_sha":null,"homepage":"","language":"OpenAPI Specification v3","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scottgriv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2024-02-08T23:41:31.000Z","updated_at":"2025-01-09T04:28:03.000Z","dependencies_parsed_at":"2024-02-09T02:11:05.452Z","dependency_job_id":"44ca2ef1-02f2-49e0-8727-3d604c67cc7a","html_url":"https://github.com/scottgriv/swagger-openapi-user_management_demo","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"792ab56ba3314fcb71acb8d73d4619727c5fffc0"},"previous_names":["scottgriv/swagger-openapi-user_management_demo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fswagger-openapi-user_management_demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fswagger-openapi-user_management_demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fswagger-openapi-user_management_demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fswagger-openapi-user_management_demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scottgriv","download_url":"https://codeload.github.com/scottgriv/swagger-openapi-user_management_demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244945596,"owners_count":20536295,"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":["api","oas","open-api","openapi","swagger"],"created_at":"2024-09-25T10:36:20.118Z","updated_at":"2026-01-04T21:47:53.027Z","avatar_url":"https://github.com/scottgriv.png","language":"OpenAPI Specification v3","funding_links":["https://www.buymeacoffee.com/scottgriv"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Begin README --\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/scottgriv/swagger-openapi-user_management_demo\" target=\"_blank\"\u003e\u003cimg src=\"./docs/images/icon.png\" width=\"150\" height=\"150\"/\u003e\u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://github.com/scottgriv/swagger-openapi-user_management_demo\" target=\"_blank\"\u003e\u003cimg src=\"./docs/images/icon_2.png\" width=\"150\" height=\"150\"/\u003e\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.openapis.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/OpenAPI-3.1.0-6BA539?style=for-the-badge\u0026logo=openapiinitiative\" alt=\"OpenAPI Badge\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://petstore.swagger.io/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Swagger_UI-5.11.3-85EA2D?style=for-the-badge\u0026logo=swagger\" alt=\"Swagger Badge\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/scottgriv\"\u003e\u003cimg src=\"https://img.shields.io/badge/github-follow_me-181717?style=for-the-badge\u0026logo=github\u0026color=181717\" alt=\"GitHub Badge\" /\u003e\u003c/a\u003e\n    \u003ca href=\"mailto:scott.grivner@gmail.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/gmail-contact_me-EA4335?style=for-the-badge\u0026logo=gmail\" alt=\"Email Badge\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.buymeacoffee.com/scottgriv\"\u003e\u003cimg src=\"https://img.shields.io/badge/buy_me_a_coffee-support_me-FFDD00?style=for-the-badge\u0026logo=buymeacoffee\u0026color=FFDD00\" alt=\"BuyMeACoffee Badge\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://prgportfolio.com\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/PRG-Bronze Project-CD7F32?style=for-the-badge\u0026logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iMjYuMDAwMDAwcHQiIGhlaWdodD0iMzQuMDAwMDAwcHQiIHZpZXdCb3g9IjAgMCAyNi4wMDAwMDAgMzQuMDAwMDAwIgogcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCI+Cgo8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwLjAwMDAwMCwzNC4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiCmZpbGw9IiNDRDdGMzIiIHN0cm9rZT0ibm9uZSI+CjxwYXRoIGQ9Ik0xMiAzMjggYy04IC04IC0xMiAtNTEgLTEyIC0xMzUgMCAtMTA5IDIgLTEyNSAxOSAtMTQwIDQyIC0zOCA0OAotNDIgNTkgLTMxIDcgNyAxNyA2IDMxIC0xIDEzIC03IDIxIC04IDIxIC0yIDAgNiAyOCAxMSA2MyAxMyBsNjIgMyAwIDE1MCAwCjE1MCAtMTE1IDMgYy04MSAyIC0xMTkgLTEgLTEyOCAtMTB6IG0xMDIgLTc0IGMtNiAtMzMgLTUgLTM2IDE3IC0zMiAxOCAyIDIzCjggMjEgMjUgLTMgMjQgMTUgNDAgMzAgMjUgMTQgLTE0IC0xNyAtNTkgLTQ4IC02NiAtMjAgLTUgLTIzIC0xMSAtMTggLTMyIDYKLTIxIDMgLTI1IC0xMSAtMjIgLTE2IDIgLTE4IDEzIC0xOCA2NiAxIDc3IDAgNzIgMTggNzIgMTMgMCAxNSAtNyA5IC0zNnoKbTExNiAtMTY5IGMwIC0yMyAtMyAtMjUgLTQ5IC0yNSAtNDAgMCAtNTAgMyAtNTQgMjAgLTMgMTQgLTE0IDIwIC0zMiAyMCAtMTgKMCAtMjkgLTYgLTMyIC0yMCAtNyAtMjUgLTIzIC0yNiAtMjMgLTIgMCAyOSA4IDMyIDEwMiAzMiA4NyAwIDg4IDAgODggLTI1eiIvPgo8L2c+Cjwvc3ZnPgo=\" alt=\"Bronze\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---------------\n\n\u003ch1 align=\"center\"\u003eSwagger UI + OpenAPI Specification \u003cbr\u003e User Management Demo\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"swagger-openapi-user_management_demo\"\u003e\u003cimg src=\"./docs/images/demo_1.png\" width=\"25%\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ci\u003eHarnessing the power of Swagger \u0026 OAS\u003c/i\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\nThis demo project showcases the implementation of a User Management API documented with Swagger UI and defined using the OpenAPI Specification (OAS). It demonstrates the creation of interactive API documentation that allows for easy exploration and testing of API endpoints directly through the browser.\n\nSwagger UI provides a dynamic interface for visualizing and interacting with the API's capabilities, such as user creation, listing, and retrieval, without writing code. The use of OAS ensures that the API design is standardized, making it clear and understandable, which facilitates efficient integration and enhances developer experience.\n\n\u003e [!NOTE]\n\u003e *You can build OAS files in either YAML or JSON then use Swagger UI to view the specifications.*\n\nKey aspects include:\n\n- **Interactive Documentation:** Swagger UI offers an engaging way to understand and test the API.\n- **Standardization:** The OpenAPI Specification promotes clear and consistent API design principles.\n- **Developer Efficiency:** Streamlines integration efforts with comprehensive documentation.\n- **Security and Scalability:** Focuses on secure and scalable API design from the ground up.\n\nThis demo project illustrates the power of combining Swagger UI and OAS to create well-documented, easily navigable, and developer-friendly API documentation.\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://petstore.swagger.io/\"\u003e\u003cimg src=\"./docs/images/demo_2.png\" width=\"75%\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ci\u003eMy demo YAML file in Swagger UI\u003c/i\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://petstore.swagger.io/\"\u003e\u003cimg src=\"./docs/images/demo_3.png\" width=\"75%\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ci\u003eSwagger UI's more robust demo\u003c/i\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n---------------\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n- [Resources](#resources)\n- [License](#license)\n- [Credits](#credits)\n\n## Getting Started\n\n- Copy the `user-management-api.yaml` file into [Swagger Editor](https://editor.swagger.io/) to view the Swagger UI documentation.\n- To run on local, I copied the `dist` folder from the [Swagger UI Repository](https://github.com/swagger-api/swagger-ui/tree/master), and adjusted the `swagger-initilizer.js` file to point to my `user-management-api.yaml` file (Requires disabling CORS policy for your browser).\n- Consult the resources section below for more information on Swagger and OAS for APIs.\n\n## Resources\n\n**Technologies:**\n- [OpenAPI Initiative](https://www.openapis.org/)\n- [Swagger OpenAPI Specification](https://swagger.io/specification/)\n- [Swagger](https://swagger.io/)\n- [SwaggerHub](https://swagger.io/tools/swaggerhub/)\n- [SwaggerHub Explore](https://swagger.io/tools/swaggerhub-explore/)\n- [Swagger Inspector (Sunset)](https://swagger.io/blog/swagger-inspector-sunset/)\n- [Swagger Editor](https://editor.swagger.io/)\n- [Swagger Next Editor](https://editor-next.swagger.io/)\n- [Swagger UI Download](https://swagger.io/tools/swagger-ui/download/)\n- [Swagger UI Repository](https://github.com/swagger-api/swagger-ui/tree/master)\n- [Swagger UI Official Demo](https://petstore.swagger.io/)\n- [JSON Web Tokens (JWT)](https://jwt.io/)\n\n**OAS/Swagger Alternatives:**\n- [DapperDox](http://dapperdox.io/)\n- [RAML](https://raml.org/)\n- [README Hub](https://readme.com/)\n- [Stoplight](https://stoplight.io/)\n- [Apiary](https://apiary.io/)\n\n## License\n\nThis project is released under the terms of **The Unlicense**, which allows you to use, modify, and distribute the code as you see fit. \n- [The Unlicense](https://choosealicense.com/licenses/unlicense/) removes traditional copyright restrictions, giving you the freedom to use the code in any way you choose.\n- For more details, see the [LICENSE](LICENSE) file in this repository.\n\n## Credits\n\n**Author:** [Scott Grivner](https://github.com/scottgriv) \u003cbr\u003e\n**Email:** [scott.grivner@gmail.com](mailto:scott.grivner@gmail.com) \u003cbr\u003e\n**Website:** [linktr.ee/scottgriv](https://www.linktr.ee/scottgriv) \u003cbr\u003e\n**Reference:** [Main Branch](https://github.com/scottgriv/swagger-openapi-user_management_demo) \u003cbr\u003e\n\n---------------\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://linktr.ee/scottgriv\" target=\"_blank\"\u003e\n        \u003cimg src=\"./docs/images/footer.png\" width=\"100\" height=\"100\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- End README --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscottgriv%2Fswagger-openapi-user_management_demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscottgriv%2Fswagger-openapi-user_management_demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscottgriv%2Fswagger-openapi-user_management_demo/lists"}