https://github.com/kieranmueller/swagger-ui

OpenApi + Swagger UI hello world application
https://github.com/kieranmueller/swagger-ui

api boot java open rest spring swagger ui

Last synced: about 1 month ago
JSON representation

OpenApi + Swagger UI hello world application

• Host: GitHub
• URL: https://github.com/kieranmueller/swagger-ui
• Owner: KieranMueller
• Created: 2023-11-18T00:33:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-18T00:45:48.000Z (about 1 year ago)
• Last Synced: 2024-04-20T13:09:11.747Z (9 months ago)
• Topics: api, boot, java, open, rest, spring, swagger, ui
• Language: Java
• Homepage: http://localhost:8081/swagger-ui/index.html
• Size: 63.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# How to run

- Clone the project, build with Maven

- There are two controllers, cats and dogs

- To hit these controllers, the URIs are

    - http://localhost:8081/cats

    - http://localhost:8081/dogs

- The point of this application is to demonstrate automated API documentation using OpenAPI

- Navigate to http://localhost:8081/swagger-ui/index.html#/ to view the generated documentation

- Navigate to http://localhost:8081/v3/api-docs for the raw JSON documentation

# How to replicate

- Simply add the dependency (check for newer version)

  - groupId: org.springdoc

  - artifactId: springdoc-openapi-starter-webmvc-ui

  - version: 2.2.0

- Create your REST API and visit the provided endpoints

    - /swagger-ui/index.html

    - /v3/api-docs