😀
Hyune's Wiki
  • Welcome
  • Article
    • Link
  • Mentor & Code Reviewer
    • 진행하기에 앞서..
    • Code Review History
      • 한방 쿼리 vs 애플리케이션에서 조립
      • DB에서 TIMESTAMP와 DATETIME 타입의 차이
      • Service는 어떤 dto를 반환해야 할까?
        • 확장 질문
  • Legacy
    • 실무 경험 & 팁
      • Kotlin
        • 파일 조작하기
      • Infra
        • Lightsail
          • 인스턴스 구성 예제
        • 공인 ip 확인하기
      • Database
        • INSERT INTO SELECT SHARED LOCK(row LOCK)
      • API Document
        • OpenAPI (Swagger 3.0)
          • 정적 문서 내보내기
      • Side Project
        • Codesquad
      • ETC
        • HTTP Request 추적하기 with HAR File
    • Study
      • Language
        • Java
          • Copy
          • 메모리 관리
          • Garbage Collection
          • 자료구조
          • Java 17
        • Kotlin
          • Coroutine
      • Framework & Library
        • Spring
          • Spring Security
          • @Component vs @Configuration
        • JPA
          • show-sql 설정의 단점
          • @GeneratedValue strategy
          • Entity의 field type
        • Logback
          • 기본 설정
        • Monitoring
          • VisualVM
            • 설치
            • 문자열 생성으로 테스트
          • nGrinder
      • Database
        • MySQL
          • SQL 문 수행 절차
          • 트랜잭션과 잠금
          • 인덱스
      • Infra
        • AWS
          • S3
            • 용어
            • Amazon SDK 1.x with Spring
          • DynamoDB
            • Get vs Query vs Scan
        • Docker & Kubernetes
      • Computer Science
        • OS
          • Process vs Thread
          • Process
        • Web
          • HTTP
            • HTTP vs HTTPS
            • HTTP 구성
            • HTTP 그외
          • REST API
            • GET 메서드에 payload를 사용해도 되는가?
            • 특정 목적의 API는 어떻게 만들어야 할까?
          • TCP / UDP
          • 인터넷의 작동 원리
          • OAuth 2.0
        • Design Pattern
          • Builder Pattern
        • MSA
        • DDD
      • Test
        • Test Doule
      • Book & Online Class
        • 한 번에 끝내는 Spring 완.전.판 초격차 패키지 Online
          • AOP, Aspect Oriented Programming
          • Data Binding
          • IoC(Inversion of Control), DI(Dependency Injection)
          • Null Safety
          • Spring Resource
          • Spring Boot 버전별 변화
          • SpEL, Spring Expression Language
          • Validation
        • 이펙티브 자바 3판
          • 2장 객체 생성과 파괴
            • 아이템 1. 생성자 대신 정적 팩터리 메서드를 고려하라
            • 아이템 2. 생성자에 매개변수가 많다면 빌더를 고려하라
            • 아이템 3. private 생성자나 열거 타입으로 싱글턴임을 보증하라
            • 아이템 4. 인스턴스화를 막으려거든 private 생성자를 사용하라
            • 아이템 5. 자원을 직접 명시하지 말고 의존 객체 주입을 사용하라
            • 아이템 7. 다 쓴 객체 참조를 해제하라
          • 3장 모든 객체의 공통 메서드
            • 아이템 11. equals를 재정의하려거든 hashCode도 재정의하라
            • 아이템 12. toString을 항상 재정의하라
            • 아이템 14. Comparable을 구현할지 고려하라
          • 4장 클래스와 인터페이스
      • Webinar
        • 요즘 힙한 스타트업의 DBDB DEEP한 이야기
Powered by GitBook
On this page
  • 1. boot sample project with swagger
  • 2. export schema (json)
  • 3. check schema
  • 4. convert to document
  • Reference

Was this helpful?

Edit on GitHub
  1. Legacy
  2. 실무 경험 & 팁
  3. API Document
  4. OpenAPI (Swagger 3.0)

정적 문서 내보내기

PreviousOpenAPI (Swagger 3.0)NextSide Project

Last updated 2 years ago

Was this helpful?

swagger 를 작성하는 프로젝트의 경우 보통 url 전달로 API 명세를 소통합니다. 하지만 망 분리 등의 이슈로 직접 접근이 불가능한 경우 부득이하게 문서를 전달해야 되는 경우가 있습니다. 이 때 만약 명세를 위한 문서를 별도로 작성한다면 문서와 실제 API 의 간극이 발생합니다. 다행히 swagger 는 이를 보완하기 위한 기능을 제공하고 있습니다.

1. boot sample project with swagger

  • 3개의 sample API 구현

  • sample respone spec 확인 가능

2. export schema (json)

  • url 가져오기

    • /v3/api-docs 링크를 누르거나

    • console 에서 명령어를 통해 url 을 가져옵니다.

// 3.x
> ui.getConfigs().url

// 2.x
> swaggerUi.api.url

3. check schema

4. convert to document

  • json 을 붙여넣기만 하면 완성!

  • 필요시 yml 전환 가능

Reference

https://editor.swagger.io/
Documenting a Spring REST API Using OpenAPI 3.0 | BaeldungBaeldung
How to export swagger.json (or yaml)Stack Overflow
Logo
Logo