{"id":18752550,"url":"https://github.com/hendisantika/springboot-open-api-spec","last_synced_at":"2025-07-14T07:38:57.997Z","repository":{"id":67605809,"uuid":"310460317","full_name":"hendisantika/springboot-open-api-spec","owner":"hendisantika","description":"Spring Boot Open API Specification using Swagger 3","archived":false,"fork":false,"pushed_at":"2025-06-19T23:18:20.000Z","size":2698,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-19T23:29:19.078Z","etag":null,"topics":["open-api-v3","spring-doc","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hendisantika.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2020-11-06T01:31:05.000Z","updated_at":"2025-06-07T22:46:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5aade44-af8b-4ff8-a5c2-1e447eb157aa","html_url":"https://github.com/hendisantika/springboot-open-api-spec","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hendisantika/springboot-open-api-spec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hendisantika%2Fspringboot-open-api-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hendisantika%2Fspringboot-open-api-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hendisantika%2Fspringboot-open-api-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hendisantika%2Fspringboot-open-api-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hendisantika","download_url":"https://codeload.github.com/hendisantika/springboot-open-api-spec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hendisantika%2Fspringboot-open-api-spec/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265257580,"owners_count":23735764,"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":["open-api-v3","spring-doc","swagger","swagger-ui"],"created_at":"2024-11-07T17:20:56.544Z","updated_at":"2025-07-14T07:38:57.974Z","avatar_url":"https://github.com/hendisantika.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# springboot-open-api-spec\nThis is a demo project to understand basic implementation of Open API Specification. The Swagger UI will be configured and rendered.\n\nThe blog URL [OpenAPI Specification — Swagger UI](https://sourabhparsekar.medium.com/open-api-specification-swagger3-fc9ad3bbacdd) \n\n## Swagger UI for API Specification\nSwagger UI v3 provides a display framework that reads API specification document and generates an interactive documentation website. \n\nBelow URL can be used to access Swagger UI when the spring-boot application is run locally. Swagger UI endpoint can be customized via application.properties file. This will be described in later sections. \n\n\u003e [Localhost Swagger UI](http://localhost:8080/open-api-demo/swagger-ui.html)\n\n## Default API Endpoint \nOn systems running the `API`, it is recommended to use the below port for starting an API instance. \n\u003e `8080` - default api listening port \n\n## API Build \u0026 deploy from `GIT` repository\nBelow section would cover tasks required to configure and deploy api jar\n\n1. Clone repo on local system. By default, jars would be taken from Maven Central Repository\n2. Update properties in logback-spring.xml, application.properties if required. \n3. Build the project using Maven command `mvn clean install`\n4. Copy .jar file created in /project-directory/target/ to `deployment-directory`\n5. Environment specific `application.proeprties` \u0026 `logback-spring.xml` files if modified, then they are to be placed in deployment-directory along with the jar file.\n6. Start the jar execution with command `java -jar \u003cproject-name\u003e-\u003cversion\u003e.jar`   \n    \u003e    eg:  java -jar open-api3-0.0.1-SNAPSHOT.jar\n7. Logs are generated in `/deployment-directory/logs/` folder or as mentioned in `logback-spring.xml` file\n\n## Configure application.properties\nBelow section describes how to configure application.properties file to override the default values.  \n\n- Spring Boot Server Port\n    \u003e `server.port`=8080\n\n- Spring Boot Application name\n    \u003e `spring.application.name`=open-api-demo\n\n- Spring Boot Application Context path\n    \u003e `spring.servlet.context-path`=/open-api-demo\n\n- Open API Configuration Properties\n    \u003e `openapi.title`=Open API Demo  \n     `openapi.version`=v1.0.0  \n     `openapi.description`=Swagger UI using Open API Specification \n\n- Default Open API endpoint Specifications\n    - api docs endpoint path\n        \u003e `springdoc.api-docs.path`=/v3/api-docs\n    - customise endpoint for Swagger UI\n        \u003e `springdoc.swagger-ui.path`=/swagger-ui.html\n    - disable default petstore Swagger\n        \u003e `springdoc.swagger-ui.disable-swagger-default-url`=true\n## Images Screen shot\n\nSwagger UI Home Page\n\n![Swagger UI Home Page](img/home.png \"Swagger UI Home Page\")\n\nAdd New Person\n\n![Add New Person](img/add.png \"Add New Person\")\n\nList All Person\n\n![List All Person](img/list.png \"List All Person\")\n\nUpdate Person by ID\n\n![Update Person by ID](img/update.png \"Update Person by ID\")\n\nGet Person by ID\n\n![Get Person by ID](img/find.png \"Get Person by ID\")\n\nDelete Person\n\n![Delete Person](img/delete.png \"Delete Person\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhendisantika%2Fspringboot-open-api-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhendisantika%2Fspringboot-open-api-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhendisantika%2Fspringboot-open-api-spec/lists"}