{"componentChunkName":"component---src-templates-blog-post-js","path":"/springboot/스프링-부트-swagger-api-문서-자동화/","result":{"data":{"site":{"siteMetadata":{"title":"Bottlehs Tech Blog","description":"웹·앱·AI 개발자 전병훈(bottlehs)의 기술 블로그. AI·LLM, JavaScript·Vue, Spring Boot, 알고리즘, 블록체인 실무 가이드를 다룹니다","siteUrl":"https://www.bottlehs.dev","author":{"name":"Jeon Byung Hun","summary":"개발을 즐기는 bottlehs - Engineer, MS, AI, FE, BE, OS, IOT, Blockchain, 설계, 테스트"},"social":{"github":"bottlehs","codepen":"bottlehs"}}},"markdownRemark":{"id":"7e98797e-b076-5f06-967d-5466fa574d90","excerpt":"스프링 부트 Swagger API 문서 자동화 Swagger는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. 대부분의 사용자들은 스웨거 UI…","html":"

\"스프링

\n

Swagger는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. 대부분의 사용자들은 스웨거 UI 도구를 통해 스웨거를 식별하며 스웨거 툴셋에는 자동화된 문서화, 코드 생성, 테스트 케이스 생성 지원이 포함된다.

\n

Swagger는 간단한 설정으로 프로젝트에서 지정한 URL들을 HTML화면으로 확인할 수 있게 해준다.

\n

Swagger Dependency Library 추가

\n

설정은 아래와 같이 dependencies 에 swagger 를 추가해 준다.

\n
dependencies {\n  ...\n\tcompile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'\n\tcompile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'\n  ...\n}
\n

SwaggerConfig.java 파일 생성

\n
package com.coffee.coffee;\n\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport springfox.documentation.builders.PathSelectors;\nimport springfox.documentation.builders.RequestHandlerSelectors;\nimport springfox.documentation.spi.DocumentationType;\nimport springfox.documentation.spring.web.plugins.Docket;\nimport springfox.documentation.swagger2.annotations.EnableSwagger2;\n\n@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n  @Bean\n  public Docket api() {\n    return new Docket(DocumentationType.SWAGGER_2).select()\n        .apis(RequestHandlerSelectors.basePackage(\"com.coffee.coffee\")).paths(PathSelectors.any()).build();\n  }\n}
\n

Swagger UI 실행

\n

SwaggerConfig.java 에서 해당 Controller를 Swagger API 문서로 지정한다.\n브라우저를 통해 domain/swagger-ui.html 로 이동하면 Swagger API 문서 페이지를 볼 수 있다.

\n

\"스프링

","tableOfContents":"","wordCount":{"words":101},"fields":{"slug":"/springboot/스프링-부트-swagger-api-문서-자동화/","image":"//assets/springboot.png","faq":[]},"frontmatter":{"title":"스프링 부트 Swagger API 문서 자동화","date":"2021년 4월 1일","dateISO":"2021-04-01T23:39:29.537Z","updatedISO":null,"category":"springboot","description":"Swagger는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. 대부분의 사용자들은 스웨거 UI 도구를 통해 스웨거를 식별하며 스웨거 툴셋에는 자동화된 문서화, 코드 생성, 테스트 케이스 생성 지원이 포함되며, 간단한 설정으로 프로젝트에서 지정한 URL들을 HTML화면으로 확인할 수 있게 해준다.","tags":["스프링","스프링부트","Spring","SpringBoot","Java","프레임워크","Swagger"]}}},"pageContext":{"slug":"/springboot/스프링-부트-swagger-api-문서-자동화/","previous":{"fields":{"slug":"/springboot/스프링-부트-mariadb-연동/"},"frontmatter":{"title":"스프링 부트 MariaDB 연동","tags":["스프링","스프링부트","Spring","SpringBoot","Java","프레임워크","MariaDB","JDBC"]}},"next":{"fields":{"slug":"/vue/vue-js-router-설치-및-설정/"},"frontmatter":{"title":"Vue JS Router 설치 및 설정","tags":["vue","javascript","framework","frontend","web","router"]}}}},"staticQueryHashes":["213619243","3262363727"]}