postman and postman2md

2015-10-03

postman




API μž‘μ—…μ„ ν• λ•Œ ν…ŒμŠ€νŠΈν• μˆ˜ μžˆλŠ” 툴이 ν•„μš”ν•œλ°, μ‰½κ²Œ ν…ŒμŠ€νŠΈ ν• μˆ˜ μžˆλŠ” postman μ΄λΌλŠ” 툴이 μžˆλ‹€. λ‘œκ·ΈμΈλ„ ν•„μš”μ—†κ³  μ‰½κ²Œ GET, POST λ“±μ˜ HTTP 기반의 API듀을 ν…ŒμŠ€νŠΈν• μˆ˜ μžˆλ‹€. 특히 history κΈ°λŠ₯이 μžˆμ–΄μ„œ 맀우 쒋은데 μ–Έμ œ 듀어가더라도 이전에 λ‚΄κ°€ ν…ŒμŠ€νŠΈν–ˆλ˜ 내역듀을 λ³Ό μˆ˜κ°€ μžˆλ‹€. postman 이 2.0 으둜 버전업을 ν•˜λ©΄μ„œ λ‘œκ·ΈμΈμ„ ν•  μˆ˜κ°€ 있고 collection μ΄λΌλŠ” κ°œλ…μ„ λ„μž…ν–ˆλ‹€. collection 은 기쑴의 ν…ŒμŠ€νŠΈ 내역에 λŒ€ν•œ μ§‘ν•©κ°œλ…μΈλ°, λ‚΄κ°€ ν…ŒμŠ€νŠΈ ν–ˆλ˜ 것듀을 λ¬Άμ–΄μ„œ 관리 ν•  μˆ˜κ°€ μžˆλ‹€. κ·Έλž˜μ„œ μ—¬λŸ¬ collection 을 λ§Œλ“€μˆ˜ μžˆλŠ”λ°, νŠΉλ³„ν•œ κΈ°λŠ₯쀑 ν•˜λ‚˜λŠ” collection 즉, ν…ŒμŠ€νŠΈ ν•­λͺ©μ˜ 집합듀을 json ν˜•νƒœλ‘œ λ‹€μš΄ λ°›λŠ” κΈ°λŠ₯을 μ œκ³΅ν•˜κ³  μžˆλ‹€. Β 

postamn2

postman2md μ†Œκ°œ 및 개발기




postman-to-markdown(μ΄ν•˜ postman2md)은 postman μ—μ„œ λ‹€μš΄λ°›μ€ collection json ν˜•μ‹μ„ markdown 으둜 λ³€ν™˜ν•΄μ£ΌλŠ” 파이썬(python)으둜 λ§Œλ“  νˆ΄μ΄λ‹€. 일단 보톡 API λ₯Ό μ •μ˜ν•˜κ³ (λ¬Έμ„œκ°€ μ•„λ‹Œ λŒ€λž΅ μƒκ°μœΌλ‘œ) λ§Œλ“€λ©΄μ„œ postman 으둜 ν…ŒμŠ€νŠΈν•˜λŠ” λ°©μ‹μœΌλ‘œ κ°œλ°œμ„ ν•˜κ²Œ λ˜λŠ”λ°, 차후에 λ‹€μ‹œ κ°œλ°œν•œ 것을 λ°”νƒ•μœΌλ‘œ API λ¬Έμ„œλ₯Ό markdown ν˜•μ‹μœΌλ‘œ λ§Œλ“œλŠ” 과정을 κ±°μΉ˜λŠ” 것을 μ•Œκ²Œ λ˜μ—ˆλ‹€.(λ‹€λ₯Έ 뢄듀은 λ‹€λ₯Έ κ³Όμ •μœΌλ‘œ κ°œλ°œν•˜κ² μ§€λ§Œ.) κ·Έλž˜μ„œ ꡳ이 λ‹€μ‹œ APIλ₯Ό 보고 markdown 을 λ§Œλ“€κΈ° λ³΄λ‹€λŠ” ν…ŒμŠ€νŠΈν•œ postman을 μ΄μš©ν•΄μ„œ μ–΄λŠμ •λ„μ˜ markdown 기반의 APIλ¬Έμ„œλ₯Ό λ§Œλ“œλŠ”κ²Œ ν•„μš”ν•˜λ‹€κ³  μƒκ°ν•˜κ²Œ λ˜μ—ˆλ‹€.

μ‚¬μš©λ²•μ€ μœ„μ™€ κ°™λ‹€. postman collection json은 내뢀에 ν•˜λ‚˜ μ΄μƒμ˜ API ν…ŒμŠ€νŠΈλ₯Ό κ°€μ§€κ³  있기 λ•Œλ¬Έμ— markdown 파일 μ—­μ‹œ ν•˜λ‚˜ ν˜Ήμ€ ν•˜λ‚˜μ΄μƒμœΌλ‘œ λ§Œλ“€μ§€λ₯Ό μ„ νƒν• μˆ˜ μžˆλŠ”λ° multi_file 에 false 값을 주게 되면 ν•˜λ‚˜μ˜ 파일둜 λ§Œλ“€μ–΄ μ€€λ‹€. λ§Œλ“€μ–΄μ§€λŠ” 파일의 κ²½λ‘œλŠ” ν˜„μž¬ κ²½λ‘œμ—μ„œ ν•΄λ‹Ή collection μ΄λ¦„μ˜ 디렉토리가 생기고 ν•˜μœ„μ— 파일둜 생긴닀. 예λ₯Όλ“€λ©΄ example.json.postman_collection νŒŒμΌλ‚΄ name ν•­λͺ©μ΄ example 이라면, example μ΄λΌλŠ” 디렉토리λ₯Ό λ§Œλ“€κ³ , κ·Έ μ•ˆμ—μ„œ 각 API 의 이름에 λ”°λΌμ„œ markdown νŒŒμΌμ„ λ§Œλ“€μ–΄ μ€€λ‹€. λ§Œμ•½ multi_fileλ₯Ό false둜 μ„€μ •ν–ˆλ‹€λ©΄, example.md λΌλŠ” μ΄λ¦„μœΌλ‘œ ν•˜λ‚˜μ˜ 파일이 μƒμ„±λœλ‹€.

스크란샷 2015-10-03 α„‹α…©α„Œα…₯ᆫ 10.51.39

markdown λ‚΄μ—λŠ” ResourceURL, Request Parameters, Request Example 헀더λ₯Ό λ‘μ–΄μ„œ μž‘μ„±ν•˜κ³  μžˆλŠ”λ°, μ•„μ‰½κ²Œλ„ postman collection json μ—μ„œλŠ” response 에 λŒ€ν•΄μ„œλŠ” μ €μž₯ν•˜κ³  μžˆμ§€ μ•ŠκΈ° 떄문에 Response에 λŒ€ν•΄μ„œλŠ” 보여쀄 λ‚΄μš©μ΄ μ—†λ‹€. 그리고 아직은 postman2md μ—μ„œ headers 뢀뢄은 markdown으둜 λ§Œλ“€κ³  μžˆμ§€λŠ” μ•Šλ‹€.

postman2md λŠ” λ‚΄λΆ€μ μœΌλ‘œ markdownwriter 라이브러리λ₯Ό μ΄μš©ν•˜κ³  μžˆλ‹€. postman2md __init__.py λ₯Ό 보면 json νŒŒμ‹± λΆ€λΆ„κ³Ό markdownwriter μ‚¬μš©ν•˜λŠ” 뢀뢄을 λ³Ό 수 μžˆλ‹€. Β 

postman 팁 ν•œ 가지더

postman μ—μ„œ ν”„λ‘œκ·Έλž˜λ° μ–Έμ–΄λ³„λ‘œ ν…ŒμŠ€νŒ…ν•œ API에 λŒ€ν•œ μ½”λ“œμ‘°κ°μ„ λ°›μ„μˆ˜κ°€ μžˆλ‹€. λ‹€μ–‘ν•œ μ–Έμ–΄λ₯Ό μ§€μ›ν•˜κ³  μžˆλŠ”λ° νŠΉμ΄ν•œ 점은 각 μ–Έμ–΄λ³„λ‘œ APIλ₯Ό ν˜ΈμΆœν•˜λŠ” μ—¬λŸ¬ 방식을 μ§€μ›ν•˜κ³  μžˆλ‹€λŠ” 점이닀. 예λ₯Ό λ“€λ©΄, 파이썬의 경우, python3 λ₯Ό μ„ νƒν•˜λ©΄ http.client 에 μžˆλŠ” 라이브러리둜 μ½”λ“œλ₯Ό ν‘œμ‹œν•˜μ§€λ§Œ, requestsλ₯Ό μ„ νƒν•˜λ©΄ ν•΄λ‹Ή λΌμ΄λΈŒλŸ¬λ¦¬μ— 맞게 μ„€μ •λœ μ½”λ“œκ°€ 좜λ ₯λœλ‹€.

postman9

postman11

#dev  #postman  #postman to markdown