https://github.com/scottgriv/swagger-openapi-user_management_demo

This demo project showcases the implementation of a User Management API documented with Swagger UI and defined using the OpenAPI Specification (OAS)
https://github.com/scottgriv/swagger-openapi-user_management_demo

api oas open-api openapi swagger

Last synced: about 1 month ago
JSON representation

This demo project showcases the implementation of a User Management API documented with Swagger UI and defined using the OpenAPI Specification (OAS)

• Host: GitHub
• URL: https://github.com/scottgriv/swagger-openapi-user_management_demo
• Owner: scottgriv
• License: unlicense
• Created: 2024-02-08T23:41:31.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-05T00:01:48.000Z (7 months ago)
• Last Synced: 2024-10-01T06:43:22.040Z (about 1 month ago)
• Topics: api, oas, open-api, openapi, swagger
• Language: OpenAPI Specification v3
• Homepage:
• Size: 2.79 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




    

     

    








    

    

    


    

    

    

    


    



---------------

Swagger UI + OpenAPI Specification 
 User Management Demo




    

    


    Harnessing the power of Swagger & OAS






This 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.

Swagger 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.

> [!NOTE]

> *You can build OAS files in either YAML or JSON then use Swagger UI to view the specifications.*

Key aspects include:

- **Interactive Documentation:** Swagger UI offers an engaging way to understand and test the API.

- **Standardization:** The OpenAPI Specification promotes clear and consistent API design principles.

- **Developer Efficiency:** Streamlines integration efforts with comprehensive documentation.

- **Security and Scalability:** Focuses on secure and scalable API design from the ground up.

This demo project illustrates the power of combining Swagger UI and OAS to create well-documented, easily navigable, and developer-friendly API documentation.



    

    


    My demo YAML file in Swagger UI








    

    


    Swagger UI's more robust demo






---------------

## Table of Contents

- [Getting Started](#getting-started)

- [Resources](#resources)

- [License](#license)

- [Credits](#credits)

## Getting Started

- Copy the `user-management-api.yaml` file into [Swagger Editor](https://editor.swagger.io/) to view the Swagger UI documentation.

- 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).

- Consult the resources section below for more information on Swagger and OAS for APIs.

## Resources

**Technologies:**

- [OpenAPI Initiative](https://www.openapis.org/)

- [Swagger OpenAPI Specification](https://swagger.io/specification/)

- [Swagger](https://swagger.io/)

- [SwaggerHub](https://swagger.io/tools/swaggerhub/)

- [SwaggerHub Explore](https://swagger.io/tools/swaggerhub-explore/)

- [Swagger Inspector (Sunset)](https://swagger.io/blog/swagger-inspector-sunset/)

- [Swagger Editor](https://editor.swagger.io/)

- [Swagger Next Editor](https://editor-next.swagger.io/)

- [Swagger UI Download](https://swagger.io/tools/swagger-ui/download/)

- [Swagger UI Repository](https://github.com/swagger-api/swagger-ui/tree/master)

- [Swagger UI Official Demo](https://petstore.swagger.io/)

- [JSON Web Tokens (JWT)](https://jwt.io/)

**OAS/Swagger Alternatives:**

- [DapperDox](http://dapperdox.io/)

- [RAML](https://raml.org/)

- [README Hub](https://readme.com/)

- [Stoplight](https://stoplight.io/)

- [Apiary](https://apiary.io/)

## License

This project is released under the terms of **The Unlicense**, which allows you to use, modify, and distribute the code as you see fit. 

- [The Unlicense](https://choosealicense.com/licenses/unlicense/) removes traditional copyright restrictions, giving you the freedom to use the code in any way you choose.

- For more details, see the [LICENSE](LICENSE) file in this repository.

## Credits

**Author:** [Scott Grivner](https://github.com/scottgriv) 


**Email:** [[email protected]](mailto:[email protected]) 


**Website:** [scottgrivner.dev](https://www.scottgrivner.dev) 


**Reference:** [Main Branch](https://github.com/scottgriv/swagger-openapi-user_management_demo) 


---------------