[API Document] Swagger

Swagger란?
 - Web API 문서화 도구
 - API들이 가지는 명세(Spec)을 관리하기 위한 프로젝트

 

Swagger의 기능
1) API Design
2) API Development
3) API Documentation
4) API Testing
5) API Mocking and Virtualization
6) API Governance
7) API Monitoring
8) OpenAPI & Swagger

 

Web API를 만들지 않고 명세화하기 (Guide)

Create new API (Link)
 1. 왼쪽 사이드 바에서 Create New API를 누르고 선택

 

 2. API 정보를 입력해야 하는 대화 상자가 표시됨

선택 사항 설명
OpenAPI Version  - API 형식을 선택, OpenAPI 2.0 또는 3.0
Template   - Petstore 또는 IOT(Internet of Things)등등 해당 샘플 API를 선택
 - 빈 API로 시작하려면 None을 선택
Name   - API 이름은 고유한 ID로 swaggerhub 경로에 포함되어 있다
 - https://app.swaggerhub.com/api/{owner}/petstore/1.0 
 - Name 규칙
   1. 3 to 60 character long
   2. allowed characters: A..Z a..z 0..9 - _ .
   3. must start and end with a letter or digit
    * 주의 API name은 case-sensitive하므로 petstore와 PetStore는 다르게 인식한다.
Owner   - personal 또는 organization계정에 API를 만들 것인지 선택
 - API 소유자는 Swagger의 API 경로에 속한다.
https://app.swaggerhub.com/api/owner/api-name/1.0
 - ororganization 소유의 API는 personal이 아닌 ororganization의 범위 안에서 제한된다.
 - organization 소유자는 organization에서 API를 생성할 수 있다.
 - Allow Designers to Create APIs under the Organization  옵션을 갖고 구성된 organization에서 Designer role을 갖고 있는 멤버는 "create" 권한을 가질 수 있다.
Project   - organization 이 Owner로 선택된 경우, API를 추가할 프로젝트를 선택할 수 있다.
 - 목록에는 사용자가 사용할 수 있는 기존 프로젝트가 포함되어 있다.
Visibility   - API를 공개할 지 비공개할 지 선택
 - Public API는 SwaggerHub의 계정이 없는 사람들도 볼 수 있다.
 - Private API는 사용자와, collaborators로 등록한 사람들만 볼 수 있다.
Auto Mock API  - https://virtserver.swaggerhub.com/{owner}/{api}/{version}에 새 mock용 API를 만들 수 있다. 
 - 위 방식으로 API를 설계할 때 테스트할 수 있으며, API 기능이 구현될 때까지 기다릴 필요 없이 개발자가 클라이언트 어플리케이션 작업을 시작할 수 있다. 
- SwaggerHub은 새로운 API를 위한 API Auto Mocking integration을 만들어 API를 저장할 때마다 자동으로 Mock을 업데이트한다.
Version   - 템플릿 없는 빈 API일 경우 작성
 - API 버전 
Title   - 템플릿 없는 빈 API일 경우 작성
 - 대화형 API 문서에 표시될 API 제목
Description   - API의 용도에 대한 개요
 - 설명은 API 정의에 포함되며 SwaggerHub의 검색 결과에도 표시된다.
 - 

 

 3. Create API 누르기

 

 

Code Editor

 

1. 상단 프로젝트 제목 및 설명

 

2. get method

 

3. post

 

4. Models

저작자표시

'Edu > 프로젝트 정리 도구' 카테고리의 다른 글

[문서정리] EVERNOTE  (0) 2018.12.29

[문서정리] 에버노트


업무 생산성, 일상 효율성을 높이자


내게 필요한 기능


[일상]

 - 하루 업무 정리

 - 주간 업무 정리

 - 연간 스케줄 관리


[개인]

 - 개인 프로젝트 작업 정리

 - 블로그 게시물 작업 정리


[회사]

 - 회의록

 - 회의안건

 - 프로젝트

 - 일간 보고

 - 주간 보고

 - 월간 보고


 에버노트 툴을 활용해서 업무의 효율성을 높일 수 있도록 해보자


1. 평소 하는 일을 모두 나열, 해야 하는 일과 하지 않아도 되는 일을 구분

2. 해야 하는 일을 효율적으로 하기 위해 에버노트의 템플릿을 활용 및 정리


목록 

템플릿

 일기, 일정관리, 주간정리

 일간, 주간, 월간 플래너 템플릿

 책 읽기

 자유

 블로그

 블로그 게시물 작업 시트 템플릿

 개인 프로젝트

 개별 프로젝트 템플릿 

 회의

 회의안건, 회의록 


[플래너 작성]

월

 - 한 달의 목표치를 설정 후 주별로 분량 조절한다.

주

 - 한 주에 정해진 학습 분량을 일간 단위로 자세하게 계획을 세운다.

 - 한 주에 계획을 세울 때 중요도를 체크하여 실천가능한 순으로 분류한다.

일

 - 일간 단위로 계획을 세울 때 무리하게 세우는 것보다는 내가 할 수 있는 선에서 계획을 세운다.

 - 하루 계획을 세웠다면 구체적으로 해야하는 일의 양을 정한다.



[블로그 작성]

 - Headline(제목) 작성시 '도입부'를 읽도록 유도하는 역할

 - Opening(도입부) 작성, 본문의 3~4 문장을 읽음으로 본문 전체를 다 읽도록 하기 위함

 - Half-Width Image(이미지), 라인당 글자수(character per line)을 줄여 독자가 글을 읽는 것이 수월해지도록 함

 - Sub-Head1(소제목1)은 첫 번째 단락을 읽게 하는 역할로 본문에서 무너가 얻는 만한 정보가 있다는 확신을 심어주는 역할

 - CTA1(콜투액션1)은 본문에 대한 요약문장을 제공하거나 트위터, 페이스북 등의 공유 버튼을 삽입으로 백링크[각주:1]로서의 역할을 함

 - Sub-Head2(소제목2)은 구체적이고 확실한 해법·결론을 제시하면서 마지막 단락으로 이어지게 함

 - Content2(본문2)은 단순하고 실행 가능한 해법을 제시함으로써 독자들에게 확실한 소득을 안김

 - CTA2(콜투액션2)은 포스팅의 최종목표(구매, 가입, 구독) 등으로 글을 마무리


참고사이트 - http://www.marketology.co.kr/seo/블로그-글-작성-요령-기본-포맷-이해하기/




[개인 프로젝트]


 - 프로젝트 미션

  - 비즈니스 문제를 해결하기 위한 목적(Purpose)

 - 프로젝트 목표

  - 프로젝트에서 생성할 제품이나 서비스의 내용을 기술

  - 프로젝트 미션을 달성하기 위해 구체적으로 무엇을 해야 하는지, 무엇을 제외해야 하는지

 - 프로젝트 성공 기준

  - 비즈니스 가치(Value)를 구현

* 프로젝트 문서 작성법 많이 찾아보기


- 개별 프로젝트



[회의]

 - 회의 안건



 - 회의록


  1. 포스트와 작가에 대한 권위를 높이고 트래픽을 늘려준다. [본문으로]
저작자표시

'Edu > 프로젝트 정리 도구' 카테고리의 다른 글

[API Document] Swagger  (0) 2018.12.30

+ Recent posts

티스토리툴바