머신-Geon
  • 홈
  • 태그
  • 방명록
  • 메뉴 닫기
  • 글작성
  • 방명록
  • 환경설정
    • 분류 전체보기 (145)
      • Git (4)
        • Issue (1)
      • JAVA (18)
        • JAVA - Security (1)
        • JAVA - API정리 (4)
        • JAVA - Spring (0)
        • JAVA - Annotation (1)
        • JAVA - API DOC (2)
        • Issue (2)
      • JPA (2)
        • 개념 정리 (0)
        • Issue (2)
      • KAFKA (7)
        • 개념 정리 (3)
        • version (3)
        • Solution (1)
        • Issue (0)
      • Algorithm (94)
        • 개념 정리 (2)
        • 문제 풀이 (92)
      • Linux (3)
      • Others (13)
        • 프로젝트 (6)
        • 용어 정리 (4)
      • IT Knowledge (2)
      • IDE Setting (0)
        • VS Code (0)
        • Issue (0)
      • 서적 (1)
        • 네트워크 (1)
        • Programing (0)
  • 홈
  • 태그
  • 방명록
JAVA/JAVA - API DOC

[API - Doc] 스웨거(Swagger) 3.0.0 with yaml

API 문서를 스웨거로 관리하는 작업을 하며 yaml파일 작성법에 대해 공식홈페이지를 통해 정리해보았다. 간단한 구조이므로 몇번 직접 쓰다보면 감이 잡힐 것이다. 정리한 것 외에도 다양하니 필요한 부분은 검색. 스웨거(Swagger) API들이 가지고 있는 정보들을 명세, 관리할 수 있는 도구. API를 문서화 하는 툴. 어노테이션을 활용할 수도 있지만 코드가 난잡해지는것을 지양해야 하기 때문에 yaml파일로 작성을 선호한다. 해당글은 yaml파일 기준 작성법이다. 스웨거를 모른다면 이전 글을 참고. 2020.09.07 - [JAVA/JAVA - API DOC] - [Spring] Swagger로 API 문서 자동화하기 1. Metadata 1.1 version openapi: 3.0.0 openapi:..

2021. 4. 13. 13:56
  • «
  • 1
  • »
반응형

전체 카테고리

  • 분류 전체보기 (145)
    • Git (4)
      • Issue (1)
    • JAVA (18)
      • JAVA - Security (1)
      • JAVA - API정리 (4)
      • JAVA - Spring (0)
      • JAVA - Annotation (1)
      • JAVA - API DOC (2)
      • Issue (2)
    • JPA (2)
      • 개념 정리 (0)
      • Issue (2)
    • KAFKA (7)
      • 개념 정리 (3)
      • version (3)
      • Solution (1)
      • Issue (0)
    • Algorithm (94)
      • 개념 정리 (2)
      • 문제 풀이 (92)
    • Linux (3)
    • Others (13)
      • 프로젝트 (6)
      • 용어 정리 (4)
    • IT Knowledge (2)
    • IDE Setting (0)
      • VS Code (0)
      • Issue (0)
    • 서적 (1)
      • 네트워크 (1)
      • Programing (0)
Powered by Privatenote Copyright © 머신-Geon All rights reserved. TistoryWhaleSkin3.4

티스토리툴바