ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • API Documentation - PostMan
    ๊ฐœ๋ฐœ 2021. 1. 27. 14:35

     

    ๐ŸŒธ TIL

     

     

     

    ํ”„๋กœ์ ํŠธ๋ฅผ ํ•˜๋‹ค๋ณด๋ฉด ๋‚˜๋ฅผ ์œ„ํ•ด์„œ๋“  ๋‹ค๋ฅธ ๊ฐœ๋ฐœ์ž๋ฅผ ์œ„ํ•ด์„œ๋“  ์ข€ ๋” ์›ํ™œํ•œ ํ˜‘์—…์„ ์œ„ํ•ด Api Documentation์ด ํ•„์š”ํ•˜๋‹ค๊ณ  ๋Š๋‚„ ๋•Œ๊ฐ€ ์˜จ๋‹ค.

    ์ด๋ฒˆ์— ๋‹ด๋‹นํ–ˆ๋˜ ํ”„๋กœ์ ํŠธ๋ฅผ ์ง„ํ–‰ํ•˜๋ฉด์„œ Api Documentation์˜ ํ•„์š”์„ฑ์„ ๋Š๋ผ๊ฒŒ ๋˜์—ˆ๊ณ , ์•„์ง ์ž˜ ์ •๋ฆฌ๋œ ๋ฌธ์„œ๊ฐ€ ์—†๋‹ค๋Š” ๊ฒƒ์„ ์•Œ๊ฒŒ๋˜์—ˆ๋‹ค.

     

     

    (...์—†....์œผ๋ฉด ๋‚ด๊ฐ€ ๋งŒ๋“ค๋ฉด ๋ผ!!!!! ใ…Žํžˆํžฃ..ใ…Žใ…Žใ…Ž.....ใ…Žใ…Ž...........)

     

     

    ์•„์ง ๋งŒ๋“ค์–ด๋ณธ ๊ฒฝํ—˜์ด ์—†์–ด์„œ ์„œํˆด๊ธฐ๋„ ํ•˜๊ณ  ์™„๋ฒฝํ•˜์ง„ ์•Š์ง€๋งŒ ์ฒ˜์Œ๋ถ€ํ„ฐ ์™„๋ฒฝํ•œ๊ฑด ์—†์œผ๋‹ˆ๊นŒ!!

     

     

     

     


     

     

    ํฌ์ŠคํŠธ๋งจ์œผ๋กœ Api Documentation ๋งŒ๋“ค๊ธฐ

     

     

    ํฌ์ŠคํŠธ๋งจ์„ ์‚ฌ์šฉํ•˜์—ฌ Api Documentation ๋งŒ๋“œ๋Š” ๋ฐฉ๋ฒ•์€ ์กฐ๊ธˆ๋งŒ ๊ตฌ๊ธ€๋งํ•ด๋„ ๋„ˆ๋ฌด ์นœ์ ˆํ•˜๊ฒŒ ๋‚˜์™€์žˆ๊ธฐ ๋•Œ๋ฌธ์— ๋งŒ๋“œ๋Š” ๋ฐฉ๋ฒ•์€ ์ ์ง€ ์•Š๊ฒ ์ง€๋งŒ, ๋งŒ๋“ค๋ฉด์„œ ์–ป์€ ์ •๋ณด๋“ค, ํŽธ๋ฆฌํ–ˆ๋˜ ์ ๋“ค์„ ๋ช‡๊ฐ€์ง€๋งŒ ์ •๋ฆฌํ•ด๋ณด๋„๋ก ํ•˜๊ฒ ๋‹ค.

     

     


     

     ๐Ÿ’ฅ ์ค‘๋ณตํ•ด์„œ ๋“ค์–ด๊ฐ€๋Š” ๊ฐ’ ํ•œ๋ฒˆ์˜ ์…‹ํŒ…์œผ๋กœ ๋๋‚ด๊ธฐ

     

    ์˜ˆ๋ฅผ๋“ค์–ด header์— ๋“ค์–ด๊ฐ€๋Š” ์ •๋ณด๋‚˜ token, params ๋“ฑ๋“ฑ ๋งค ์š”์ฒญ๋งˆ๋‹ค ๊ณตํ†ต์œผ๋กœ ๋“ค์–ด๊ฐ€๋Š” ์ •๋ณด๊ฐ€ ์žˆ๋‹ค๋ฉด Api๋ฅผ ๋งŒ๋“ค ๋•Œ๋งˆ๋‹ค ์„ค์ •ํ•ด์ฃผ๋Š” ๊ฒƒ์€ ๋ฒˆ๊ฑฐ๋กœ์šด ์ž‘์—…์ด ๋  ๊ฒƒ์ด๋‹ค.

     

    ์‹ฌ์ง€์–ด request url ๋„ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ๋‹ค!

    ์˜ˆ๋ฅผ๋“ค์–ด, ๋ณดํ†ต์€ http:// ~~~~/test/1 ์ด๋Ÿฐ ์‹์œผ๋กœ ์•ž์˜ ๋นจ๊ฐ„ ๋ถ€๋ถ„์€ root์ด๊ธฐ ๋•Œ๋ฌธ์— url์ด ๊ณตํ†ต์ด๊ณ  ๋ฐ”๋€Œ๋Š” ๋ถ€๋ถ„์€ ๋นจ๊ฐ„๋ถ€๋ถ„์˜ ๋’ค์— ์˜ค๋Š” ๋ถ€๋ถ„์ผ ๊ฒƒ์ด๋‹ค. ๊ทธ๋Ÿฌ๋‹ˆ๊นŒ ์ด ๊ณตํ†ต์ธ root url๊นŒ์ง€๋„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค!

     

     

     

     

    โš™๏ธ ์„ค์ •ํ•˜๋Š” ๋ฒ•

     

     

     

    1. ํฌ์ŠคํŠธ๋งจ์„ ์—ด์–ด๋ณด๋ฉด ์ƒ๋‹จ ์šฐ์ธก์— ์•„๋ž˜ ์‚ฌ์ง„๊ณผ ๊ฐ™์€ ๋ถ€๋ถ„์ด ์žˆ๋Š”๋ฐ, ์ œ์ผ ์˜ค๋ฅธ์ชฝ์— ์žˆ๋Š” ์„ค์ •๋ฒ„ํŠผ์„ ๋ˆ„๋ฅธ๋‹ค.

     

     

     

    2. ๊ทธ๋Ÿผ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ๋ชจ๋‹ฌ์ด ๋œจ๋Š”๋ฐ (test๋Š” ์ด๋ฏธ ํ•œ๋ฒˆ ๋งŒ๋“  ์ ์ด ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ํ•œ๋ฒˆ๋„ ๋งŒ๋“ ์ ์ด ์—†๋Š” ๊ฒฝ์šฐ๋ผ๋ฉด ์•„๋ฌด๊ฒƒ๋„ ์•ˆ๋œฐ ๊ฒƒ์ด๋‹ค.)

    Add๋ฒ„ํŠผ์„ ํด๋ฆญํ•œ๋‹ค.

     

     

     

     

     

     

    3. Add๋ฒ„ํŠผ์„ ํด๋ฆญํ•ด์„œ ๋‚˜์˜ค๋Š” ํ™”๋ฉด์— ๋‹ค์Œ๊ณผ ๊ฐ™์ด ๊ณตํ†ต์œผ๋กœ ์‚ฌ์šฉ๋  ๊ฐ’๋“ค์„ ์„ค์ •ํ•ด์ฃผ๋ฉด ๋œ๋‹ค.

    ๋ชจ๋‘ ์„ค์ •ํ–ˆ์œผ๋ฉด Update ๋ฒ„ํŠผ์„ ํด๋ฆญํ•œ๋‹ค.

     

     

     

     

     

    4. ์œ„์—์„œ ์ ์šฉํ•œ token๊ฐ’์„ ์‚ฌ์šฉํ•˜๋ ค๋ฉด ์•„๋ž˜ ์‚ฌ์ง„์ฒ˜๋Ÿผ {{token}} ์ด๋ผ๊ณ  ์ž…๋ ฅ๋งŒํ•ด์ฃผ๋ฉด ์ž๋™์œผ๋กœ ๋‚ด๊ฐ€ ์œ„์—์„œ ์„ค์ •ํ•œ token๊ฐ’์ด ์„ค์ •๋˜๋Š” ๊ฒƒ์ด๋‹ค. 

     

     

     

     

     

    ์ด๋ ‡๊ฒŒ ํŽธํ•œ ๊ธฐ๋Šฅ์ด ์žˆ๋Š”์ค„ ๋ชจ๋ฅด๊ณ  ์—ฌํƒœ Api ํ•˜๋‚˜ํ•˜๋‚˜ ๋‹ค ์„ค์ •ํ•ด์ฃผ๋Š๋ผ ๋„ˆ๋ฌด ๋ฒˆ๊ฑฐ๋กœ์› ๋Š”๋ฐ ....

    ์ด๋Ÿฐ ํŽธ๋ฆฌํ•œ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋Š” ๊ฒƒ์„ ๋ณด๋ฉด ์ด๋Ÿฐ ๊ฒƒ ๋ง๊ณ ๋„ ์ •๋ง ์ข‹์€ ๊ธฐ๋Šฅ๋“ค์ด ํ›จ์”ฌ ๋” ๋งŽ์„ ๊ฒƒ ๊ฐ™๋‹ค.

     

     

    ๋งˆ์ง€๋ง‰์œผ๋กœ ์ด๋ ‡๊ฒŒ ๋งŒ๋“  ๋ฌธ์„œ๋ฅผ ๋‹ค๋ฅธ ํŒ€์›๋“ค๊ณผ๋„ ๊ณต์œ ํ•ด์•ผ ์˜๋ฏธ๊ฐ€ ์žˆ์œผ๋‹ˆ ๋ชจ๋‘ ์ ‘๊ทผํ•˜์—ฌ ๋ณผ ์ˆ˜ ์žˆ๋Š” URL์„ ์ƒ์„ฑํ•ด๋ณด์ž.

     

     

     


     

     

    ๐Ÿ’ฅ Publish Docs ๋งŒ๋“ค๊ธฐ

     

     

    1. ๋‚ด๊ฐ€ ๋งŒ๋“  Collections์—์„œ publish ํ•  ํด๋”๋ฅผ ๋ณด๋ฉด ์šฐ์ธก์— ์•„๋ž˜์™€ ๊ฐ™์€ ๋ฒ„ํŠผ์ด ์žˆ๊ณ , ์ด ๋ฒ„ํŠผ์„ ๋ˆ„๋ฅด๋ฉด ๋ฉ”๋‰ด๋“ค์ด ๋‚˜์˜ค๋Š”๋ฐ 
    Publish Docs๋ฅผ ํด๋ฆญํ•œ๋‹ค.

     

     

     

     

     

    2. ํ•ด๋‹น ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜๋ฉด ์ฐฝ์ด ํ•˜๋‚˜ ์—ด๋ฆฌ๊ณ  ์ฐฝ์— ๋‚˜์™€์žˆ๋Š” URL์ด ๋ฐ”๋กœ Publish Docs URL์ด ๋˜๋Š” ๊ฒƒ์ด๋‹ค.

    ๋‚ด ํŒ€์›๋“ค์—๊ฒŒ ์ด URL์„ ๊ณต์œ ํ•ด์„œ ํ”„๋กœ์ ํŠธ์˜ API๋“ค์„ ํ•œ๋ˆˆ์— ๋ชจ์•„์„œ ๋ณผ ์ˆ˜ ์žˆ๊ณ , ์ƒ์„ธ ์„ค๋ช…๋„ ์ ์„ ์ˆ˜ ์žˆ์–ด์„œ ํŽธ๋ฆฌํ•˜๋‹ค.

     

    ๋˜ํ•œ exportํ•ด์„œ ํ”„๋กœ์ ํŠธ ํด๋” ๋‚ด์— import์‹œํ‚ฌ ์ˆ˜ ์žˆ๋Š” ๊ธฐ๋Šฅ๋„ ์กด์žฌํ•œ๋‹ค!

     

     

     

     


     

    ๋งˆ์น˜๋ฉฐ ๐ŸŒธ

     

    ํฌ์ŠคํŠธ๋งจ์— ์ด๋Ÿฐ ํŽธ๋ฆฌํ•œ ๊ธฐ๋Šฅ์ด ๋งŽ์€ ๊ฒƒ์„ ์ฒ˜์Œ ์•Œ๊ณ  ์ข€ ๋” ๊ตฌ๊ธ€๋งํ•˜๋‹ค ๋ณด๋‹ˆ TestCase๋„ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๋‹ค๊ณ  ํ•œ๋‹ค.

    ๋‹ค์Œ ๊ฐœ๋ฐœ์Šคํ„ฐ๋”” ๋•Œ์—๋Š” mocha/chai๋กœ ๋งŒ๋“  ํ…Œ์ŠคํŠธ ์ผ€์ด์Šค๋ฅผ ํฌ์ŠคํŠธ๋งจ์œผ๋กœ๋„ ์‹œ๋„ํ•ด๋ณผ ์ˆ˜ ์žˆ๋„๋ก ์—ฐ๊ฒฐ์‹œ์ผœ๋ณผ ๊ณ„ํš์ด๋‹ค!

     

    ๋‚ด๊ฐ€ ์ œ์•ˆํ•œ ์˜๊ฒฌ์„ ์ข‹๊ฒŒ ๋ฐ›์•„์ฃผ์‹œ๊ณ  ์Šค์Šค๋กœ ๋ฌด์–ธ๊ฐ€๋ฅผ ์ฐพ์•„์„œ ๊ฐœ์„ ํ•ด๋ณผ ์ˆ˜ ์žˆ๋„๋ก ๋งŒ๋“ค์–ด์ค€ ํšŒ์‚ฌ ํŒ€์›๋“ค์—๊ฒŒ๋„ ๊ฐ์‚ฌํ•˜๊ณ , ์ด๋ฒˆ ๊ณ„๊ธฐ๋กœ ์ข€ ๋” ์ž์‹ ๊ฐ์„ ๊ฐ–๊ณ  ํŒ€์›๋“ค์ด ํŽธํ•˜๊ฒŒ ์ผํ•  ์ˆ˜ ์žˆ๊ฒŒ ๋ถ€์กฑํ•œ ์ ๋“ค์„ ์ฐพ์•„ ํ•ด๊ฒฐํ•ด๋‚˜๊ฐ€๋ฉด ๋‚˜์—๊ฒŒ๋„ ํŒ€์›๋“ค์—๊ฒŒ๋„ ๋ชจ๋‘ ํ–‰๋ณตํ•œ ์ผ์ด ๋˜์ง€ ์•Š์„๊นŒ ํ•˜๋Š” ์ƒ๊ฐ์„ ํ•˜๊ฒŒ ๋˜์—ˆ๋‹ค.

     

     

    ๋Œ“๊ธ€ 0

Designed by Tistory.