|
|
|
OpenAPI¿Í ½º¿þ°Å¸¦ È°¿ëÇÑ ½ÇÀü API ¼³°è : ¿ä±¸»çÇ× ºÐ¼®ºÎÅÍ ºñÁî´Ï½º ¸ðµ¨ ¼³°è, ¹®¼È, ÀÚµ¿È, Å×½ºÆ®, API È®Àå°ú ÁøȱîÁö
|
|
|
¿À¸í¿î
¤Ó
Ã¥¸¸
¤Ó
Designing APIs with Swagger and Openapi
|
|
|
|
- Á¦ÈÞ¸ô ÁÖ¹® ½Ã °í°´º¸»ó, ÀϺΠÀ̺¥Æ® Âü¿© ¹× ÁõÁ¤Ç° ÁõÁ¤, ÇÏ·ç/´çÀÏ ¹è¼Û¿¡¼ Á¦¿ÜµÇ¹Ç·Î Âü°í ¹Ù¶ø´Ï´Ù.
-
-
-
½º¸¶Æ®ÇÑ °³¹ßÀ» ¿øÇÏ´Â ¹é¿£µå °³¹ßÀÚ´Â ¹°·Ð, ÇÁ·ÎÁ§Æ® Å×Å©´ÏÄà PM°ú PO, ÇÁ·ÐÆ®¿£µå °³¹ßÀÚ°¡ ¸ðµÎ ÇÔ²² Àоî¾ß ÇÒ Çʵ¶¼!
¿ä±¸»çÇ× ºÐ¼®ºÎÅÍ »ç¿ëÀÚ ½ºÅ丮 ÀÛ¼º, °í±Þ ºñÁî´Ï½º ¸ðµ¨ ¼³°è, API ¼³°è¿Í ¹®¼È, ÀÚµ¿È, Å×½ºÆ®, APIÀÇ È®Àå°ú ÁøȱîÁö, API »ç¿ëÀÚ¿Í °³¹ßÀÚ°¡ ¾Ö¿ëÇÒ À¥ API ¼³°è¿Í È°¿ë¿¡ ´ëÇÑ ¿Ïº® °¡À̵å!
½ºÇÁ¸µ ºÎÆ®(Spring Boot) À¥¼ºñ½º¿¡ ½º¿þ°Å(Swagger)¸¦ ÀÔÇô È°¿ëÇÏ´Â ¹æ¹ýÀ» ¾Ë·ÁÁÖ´Â Çѱ¹¾îÆÇ Æ¯º°ºÎ·Ïµµ ¼ö·Ï!
-
-
| ÀÌ Ã¥¿¡¼ ´Ù·ç´Â ³»¿ë |
ÀÌ Ã¥Àº API¸¦ ±â¼úÇÏ°í(describe) ¼³°èÇÏ´Â(design) ¹æ¹ýÀ» ´Ù·é´Ù. OpenAPI ¼¼»óÀ¸·Î ÀεµÇÏ´Â ÀÔ¹®¼·Î¼, ¼³°è ¿ì¼± ¿øÄ¢À» ½ÇõÇÏ´Â API °³¹ßÀÚ°¡ »ç¿ëÇÏ´Â µµ±¸¿Í »ç·Ê¸¦ µé¿©´Ùº»´Ù.
OpenAPI Á¤ÀǼ¸¦ ÀÐ°í ¾²´Â ±âÃʺÎÅÍ ½ÃÀÛÇؼ µµ¸ÞÀÎ ¼³°è, ¿öÅ©Ç÷Πº¯°æ, API µðÀÚÀÎ ÆÐÅÏÀ¸·Î ³ª¾Æ°£´Ù. OpenAPI¿Í API ¼³°è¿¡ ÃÊÁ¡À» ¸ÂÃßÁö¸¸ API ¶óÀÌÇÁ»çÀÌŬ Àü¹Ý¿¡ °ÉÄ£ ÁÖÁ¦¸¦ ¸ðµÎ ´Ù·ç·Á°í ³ë·ÂÇßÀ¸¸ç ±â¼ú °üÁ¡°ú ÇÁ·ÎÁ§Æ® °ü¸® °üÁ¡À» µÎ·ç »ìÆ캼 ¼ö ÀÖ´Ù.
OpenAPI°¡ ¾î¶² ¹®Á¦¸¦ ÇØ°áÇØ ÁÖ´ÂÁö, ¿Ö Á¸ÀçÇÏ´ÂÁö, ¾î¶»°Ô »ç¿ëÇÏ´ÂÁö ÀÌÇØÇÏ°í ÀڽۨÀ» °®´Â µ¥ ÀÌ Ã¥ÀÌ µµ¿òÀÌ µÇ¾úÀ¸¸é ÇÑ´Ù.
- OpenAPI Çü½ÄÀ¸·Î ±âÁ¸ Á¦Ç°ÀÇ API¸¦ ±â¼úÇØ º»´Ù
- OpenAPI¿Í ½º¿þ°Å¸¦ È°¿ëÇØ API ¼³°è ¿ì¼± ¹æ½Ä(design first approach)À» Àû¿ëÇØ º»´Ù
- Á¦Ç° Ãâ½Ã ÀÌÈÄ API È®Àå°ú ÁøÈ ¹æ¹ýÀ» ¾Ë¾Æº»´Ù
- OpenAPI ±¸¹®°ú ±¸Á¶¸¦ ÇнÀÇÑ´Ù
- ½º¿þ°Å¸¦ »ç¿ëÇØ OpenAPI Á¤ÀǼ¸¦ »ý¼ºÇÑ´Ù
- ÇÁ·Î¼¼½º¸¦ ÀÚµ¿ÈÇÏ°í Äڵ带 ÀÚµ¿ »ý¼ºÇØ º»´Ù
- ±â´É Á¶Á÷ °£ Çù¾÷ ¹æ½ÄÀ» ¹è¿î´Ù
| ÀÌ Ã¥ÀÇ ´ë»ó µ¶ÀÚ |
API¿¡ Èï¹Ì¸¦ °®°í ¼³°è ¿ì¼± ¹æ½ÄÀ¸·Î API¸¦ È°¿ëÇØ º¸·Á´Â ¼ÒÇÁÆ®¿þ¾î °³¹ßÀÚ°¡ Àоî¾ß Çϴ åÀÌ´Ù. ÇÁ·ÐÆ®¿£µå ¶Ç´Â ¹é¿£µå °³¹ßÀÚ, Á¦Ç° °ü¸®ÀÚ, QA Å×½ºÅÍ, ½ÉÁö¾î CEO±îÁö API °ü·Ã ÀÇ»ç°áÁ¤À» ³»·Á¾ß ÇÏ´Â ¸ðµÎ°¡ Àоî¾ß ÇÑ´Ù.
ƯÁ¤ ÁÖÁ¦¸¦ ½Éµµ ±íÀÌ ÀÌÇØÇÏ°í ÀÖÁö ¾Ê´õ¶óµµ Ã¥À» ÀÐÀ» ¼ö ÀÖµµ·Ï ÁÖÀǸ¦ ±â¿ï¿´À¸¸ç, JSONÀ̳ª HTTP °°Àº °³³ä¿¡ Àͼ÷ÇÏ´Ù¸é Ã¥À» Àд µ¥ ¾Æ¹«·± ¹®Á¦°¡ ¾øÀ» °ÍÀÌ´Ù. ¶ÇÇÑ °£´ÜÇÑ º¹½À°ú ¿ÜºÎ ÀÚ·á¿¡ ´ëÇÑ ¸µÅ©µµ ¸¹ÀÌ ´ã¾Ò´Ù.
| ÀÌ Ã¥ÀÇ ±¸¼º |
[1ºÎ] OpenAPI Çü½ÄÀ¸·Î ±âÁ¸ Á¦Ç°ÀÇ API¸¦ ±â¼úÇØ º¸±â
¡Ü 1Àå: API¸¦ ±â¼úÇÏ´Â ÀÇÀÇ¿Í ¹æ¹ý
¡Ü 2Àå: API¸¦ ŽÇèÇÏ´Â µ¥ »ç¿ëÇÏ´Â µµ±¸ÀÎ Æ÷½ºÆ®¸Ç(Postman) ¼³¸í
¡Ü 3Àå: ÀÌ¹Ì ¸¸µé¾îÁ® ÀÖ´Â Á÷ÆÇÀå(Farmstall) API¸¦ ±â¼úÇÏ´Â ¹æ¹ý
¡Ü 4Àå: ½º¿þ°Å ¿¡µðÅÍ »ç¿ë ¹æ¹ý
¡Ü 5Àå: ±âº»ÀûÀÎ API ¿äû°ú ÀÀ´ä ±â¼úÇØ º¸±â
¡Ü 6Àå: ¿äû º»¹®°ú ÀÀ´ä º»¹® ´Ù·ï º¸±â
¡Ü 7Àå: ÀÎÁõ°ú Àΰ¡ ¾Ë¾Æº¸±â
¡Ü 8Àå: ½º¿þ°Å UI¸¦ »ç¿ëÇØ API ¹®¼¸¦ Á¦°øÇÏ´Â À¥»çÀÌÆ®¸¦ È£½ºÆÃÇÏ´Â ¹æ¹ý
[2ºÎ] ¹éÁö »óÅ¿¡¼ OpenAPI¿Í ½º¿þ°Å¸¦ È°¿ëÇØ API¸¦ ¼³°èÇØ º¸±â
¡Ü 9Àå: 2ºÎ Àü¹Ý¿¡ °ÉÃÄ ´Ù·ç°Ô µÉ Æê½ÃÅÍ(PetSitter) ÇÁ·ÎÁ§Æ® ¼Ò°³
¡Ü 10Àå: API¸¦ ¼³°èÇÏ°í OpenAPI¸¦ »ç¿ëÇØ API¸¦ ±â¼úÇÏ´Â °úÁ¤
¡Ü 11Àå: API ¼³°è º¯°æÀ» ó¸®ÇÒ ¼ö ÀÖ´Â ±ê(Git) ±â¹ÝÀÇ ¿öÅ©Ç÷Π¼Ò°³
¡Ü 12Àå: API »ç¿ëÀÚ ÀÔÀå¿¡¼ API¿¡ ´ëÇÑ ¸ñ(mock)À» È°¿ëÇÏ°í º¯°æ¿¡ ´ëÀÀÇÏ´Â ¹æ¹ý
¡Ü 13Àå: ½º¿þ°Å ÄÚµåÁ¨À» »ç¿ëÇØ API¸¦ ±¸ÇöÇÏ´Â ¹æ¹ý
¡Ü 14Àå: API¸¦ »ç¿ëÇÒ ¼ö ÀÖµµ·Ï Áغñ¸¦ ¸¶Ä¡°í ÇÁ·ÐÆ®¿£µå¿Í ¹é¿£µå¸¦ ÅëÇÕÇÏ´Â °úÁ¤
[3ºÎ] 2ºÎ¿¡¼ ÀÛ¼ºÇÑ API ¼³°è¸¦ È®ÀåÇÏ°í ÁøȽÃÄÑ º¸±â
¡Ü 15Àå: ´ÙÀ½ ´Ü°èÀÇ API ¹Ýº¹(iteration)¿¡ ´ëÇÑ °èȹ ¼¼¿ì±â
¡Ü 16Àå: JSON ½ºÅ°¸¶ ÇÕ¼º(composition)À» »ç¿ëÇÑ µµ¸ÞÀÎ ¸ðµ¨ È®Àå
¡Ü 17Àå: API¿¡ ÇÊÅ͸µ, ÆäÀÌ¡, Á¤·Ä ±â´É Ãß°¡
¡Ü 18Àå: problem+json ÀÀ´ä Çü½ÄÀ» ¾Ë¾Æº¸°í API¿¡ ¿¡·¯ ó¸® Àû¿ëÇϱâ
¡Ü 19Àå: JSON ½ºÅ°¸¶¸¦ È®ÀåÇÏ°í ÀԷ°ª À¯È¿¼º °ËÁõ Àû¿ëÇϱâ
¡Ü 20Àå: API ¹öÀü °ü¸®¿Í Áß´ë º¯°æ(breaking change)À» ó¸®ÇÏ´Â ¹æ¹ý
¡Ü 21Àå: API ÃÖÁ¾ Ãâ½Ã Àü üũ¸®½ºÆ®
[ºÎ·Ï] ½º¿þ°Å 2.0, OpenAPI 3.0, OpenAPI 3.1ÀÇ Â÷ÀÌÁ¡
[Çѱ¹¾îÆÇ Æ¯º°ºÎ·Ï] ½ºÇÁ¸µ ºÎÆ® À¥¼ºñ½º¿¡ ½º¿þ°Å¸¦ ÀÔÇô È°¿ëÇÏ´Â ¹æ¹ý
[¿Å±äÀÌÀÇ ¸»]
ÀÎÅͳÝÀÌ ¼¼»ó¿¡ ³ª¿Â Áö ±×¸® ¿À·¡µÇÁö ¾Ê¾ÒÀ» ¶§, Áý ¹Û¿¡ ³ª°¡Áö ¾Ê°í ÀÎÅͳݸ¸À¸·Î ¾ó¸¶³ª Àß Áö³¾ ¼ö... ÀÖ´ÂÁö¸¦ ½ÇÇèÇغ¸´Â üÇè ¿¹´É ÄÁÅÙÃ÷°¡ ÀÖ¾ú´ø °É·Î ±â¾ïÇÕ´Ï´Ù. ÇÏÁö¸¸ ÀÌÁ¦ ±×·± ¿¹´ÉÀº ¾Æ¹«µµ º¸Áö ¾ÊÀ» °Í °°½À´Ï´Ù. ½º¸¶Æ®ÆùÀ» »ç¿ëÇÒ ¼ö ÀÖ´Ù¸é ´©±¸µç ÀÎÅͳݸ¸À¸·Î ºÒÆí ¾ø´Â »îÀ» ¿µÀ§ÇÒ ¼ö ÀÖ´Ù´Â »ç½ÇÀ» ´©±¸³ª ¾Ë°í ÀÖÀ¸´Ï±î¿ä.
ÀÌó·³ ¼Õ ¾È¿¡¼ ¸î ¹øÀÇ ½º¿ÍÀÌÇÁ¿Í Ŭ¸¯¸¸À¸·Î ¹°°ÇÀ» ¹Þ¾Æ »ç¿ëÇÒ ¼ö ÀÖ°í À½½ÄÀ» ¹è´Þ¹Þ¾Æ ¸ÔÀ¸¸ç, SNS¸¦ ÅëÇØ ÀÌ ¸ðµç °ÍÀ» ÀÚ¶û±îÁö ÇÒ ¼ö ÀÖ°Ô µÈ Æí¸®ÇÑ ¼¼»óÀ» µ¸º¸±â·Î °è¼Ó È®´ëÇÏ¸é¼ µé¿©´Ùº¸¸é ±× ¸¶µð¸¶µð¿¡ API°¡ ¼û¾î ÀÖÀ½À» È®ÀÎÇÒ ¼ö ÀÖÀ» °ÍÀÔ´Ï´Ù. API´Â ´Ù¾çÇÑ ¼ÒÇÁÆ®¿þ¾îÀÇ ¿¬°áÁ¡ ¿ªÇÒÀ» ÇÏ¸é¼ ÀÌ ¼¼»óÀ» µçµçÇÏ°Ô ¶°¹ÞÄ¡°í ÀÖ½À´Ï´Ù.
¼ÒÇÁÆ®¿þ¾îÀÇ ¿¬°áÁ¡ ¿ªÇÒÀ» ÇÏ´Â API´Â ¼ÒÇÁÆ®¿þ¾î °³¹ßÀڵ鿡°Ô´Â ÀÇ»ç¼ÒÅë ¼ö´ÜÀ¸·Î »ç¿ëµË´Ï´Ù. ¿øÈ°ÇÑ ÀÇ»ç¼ÒÅëÀ» À§Çؼ´Â ÁÖ°í¹Þ´Â µ¥ÀÌÅÍ Çü½Ä°ú È£Ãâ ¹æ½ÄÀ» Á¤ÀÇÇÏ´Â ±Ô°Ý°ú ±×¿¡ ´ëÇÑ Ä£ÀýÇÑ ¼³¸íÀ» ÀÛ¼ºÇØ¾ß ÇÕ´Ï´Ù. Áï API¸¦ ±â¼úÇؾß(describe) ÇÕ´Ï´Ù. OpenAPI´Â HTTP ÇÁ·ÎÅäÄÝ ±â¹ÝÀÇ HTTP API¸¦ ±â¼úÇϴ ǥÁØ ¸í¼¼À̸ç, Ç¥ÁØÀÌ ÀÖÀ¸¸é ÀÚµ¿È°¡ °¡´ÉÇØÁö¹Ç·Î OpenAPI¸¦ ÅëÇØ ¸¹Àº ÀÛ¾÷À» ÀÚµ¿ÈÇÒ ¼ö ÀÖ½À´Ï´Ù.
ÀÌ Ã¥Àº OpenAPI¸¦ »ç¿ëÇؼ API Á¤ÀǼ¸¦ ±â¼úÇÏ´Â ¹æ¹ýÀ» ¼³¸íÇÕ´Ï´Ù. ±×°É·Î ±×ÃÆ´Ù¸é ±×´ÙÁö Àç¹Ì¾ø´Â Ã¥ÀÌ µÉ ¼öµµ ÀÖ¾úÀ» ÅÙµ¥, ÀÛÀº À¥ ¼ºñ½ºÀÇ ¿ä±¸ »çÇ×À» Á¤¸®ÇÏ°í, »ç¿ëÀÚ ½ºÅ丮¸¦ ÀÛ¼ºÇÏ°í, À̸¦ ¹ÙÅÁÀ¸·Î ºñÁî´Ï½º µµ¸ÞÀÎ ¸ðµ¨À» ¼³°èÇÏ°í, À̸¦ ¹Ý¿µÇÑ API¸¦ ¼³°èÇÏ°í, OpenAPI¸¦ »ç¿ëÇؼ API Á¤ÀǼ¸¦ ÀÛ¼ºÇÏ°í, Á¤ÀǼ¸¦ ¹ÙÅÁÀ¸·Î ÀÚµ¿È¸¦ ÀÌ¿ëÇØ °³¹ß »ý»ê¼ºÀ» ³ôÀÌ°í, ½Ã°£ÀÌ Áö³²¿¡ µû¶ó API¸¦ ¸Å²ô·´°Ô ÁøȽÃÄÑ È®ÀåÇÏ´Â ¹æ¹ý±îÁö ±×¾ß¸»·Î ¸ðµç °ÍÀ» ´Ù·ç°í ÀÖ½À´Ï´Ù.
API¸¦ ¼³°èÇÏ°í´Â ÀÖÁö¸¸ ¾î¼¸é º°´Ù¸¥ ÇнÀÀ̳ª ±âÁØ ¾øÀÌ ÆíÀǼº¸¸À» »ý°¢ÇÏ¸ç ¼³°èÇÏ°í ±¸ÇöÇÏ´Ù°¡ ³ªÁß¿¡ È®ÀåÇϱ⠾î·Æ°Ô µÇ´Â ¾ÈŸ±î¿î ÀÏÀÌ ½Ç¹«ÀûÀ¸·Î ¸¹ÀÌ ¹ß»ýÇϴµ¥, ÀÌ Ã¥¿¡ ³ª¿À´Â ¸ð¹ü »ç·Ê¸¦ Àд٠º¸¸é ÀÚ¿¬½º·´°Ô È®À强 ÀÖ´Â API¸¦ ¼³°èÇÏ´Â µ¥ ÇÊ¿äÇÑ Áö½ÄÀ» ¾òÀ» ¼ö ÀÖ½À´Ï´Ù.
ÀÌ·± ³»¿ë¸¸À¸·Îµµ À¯ÀÍÇÒ ÅÙµ¥, ÀÌ ¸ðµç °úÁ¤À» Áö·çÇÏ°í µüµüÇÑ ¼³¸íÀÌ ¾Æ´Ï¶ó ½ÇÁ¦·Î ÀÛÀº ÇÁ·ÎÁ§Æ® ÆÀÀÌ ±¸¼ºµÇ°í °¢ÀÚÀÇ ¿ªÇÒÀ» ¼öÇàÇÏ¸ç ³°ü¿¡ ºÎµúÄ¡°í ÇØ°áÇÏ´Â ¸ð½ÀÀ» ¹¦»çÇÏ´Â Çü½ÄÀ¸·Î Àü°³ÇÏ°í ÀÖ¾î Èï¹ÌÁøÁøÇÏ°í Àç¹ÌÀÖ±â±îÁö ÇÕ´Ï´Ù. °Ô´Ù°¡ ¿¹Á¦¸¦ À§ÇØ °£È¤ ƯÁ¤ ±â¼úÀ» »ç¿ëÇÏ°í ÀÖ±â´Â ÇÏÁö¸¸ º»ÁúÀûÀ¸·Î ƯÁ¤ µµ±¸¿¡ Á¾¼ÓµÇ´Â ³»¿ëÀÌ ¾Æ´Ï¶ó¼, ÇѸ¶µð·Î API¸¦ ¸¸µé°í È°¿ëÇÏ´Â °³¹ßÀÚ ¸ðµÎ¿¡°Ô Àç¹ÌÀÖ°í À¯ÀÍÇÑ Ã¥ÀÔ´Ï´Ù.
ÀÌ Ã¥ÀÇ ³»¿ëÀÌ Àü¹ÝÀûÀ¸·Î OpenAPI¸¦ »ç¿ëÇØ »õ·Î¿î ½Ã½ºÅÛÀ» ¼³°èÇÏ°í ¸¸µé¾î °¡´Â °úÁ¤À» º¸¿©ÁÖ°í ÀÖ¾î¼ ÀÌ¹Ì ¸¸µé¾îÁø ½Ã½ºÅÛ¿¡´Â Àû¿ëÇÒ ¼ö ¾ø´Â °Ç°¡¶ó´Â Àǹ®ÀÌ µé ¼öµµ Àִµ¥, ´ÙÇེ·´°Ôµµ ±âÁ¸ ½Ã½ºÅÛ¿¡µµ Àû¿ëÇÒ ¹æ¹ýÀÌ ÀÖ½À´Ï´Ù. ±¹³»¿¡¼ API ¼¹ö °³¹ß¿¡ °¡Àå ³Î¸® »ç¿ëµÇ´Â ½ºÇÁ¸µ ºÎÆ® ±â¹ÝÀÇ API ¼¹ö¶ó¸é ¾ÆÁÖ °£´ÜÇÑ ¼³Á¤°ú ¾Ö³ÊÅ×À̼Ǹ¸À¸·Îµµ ½º¿þ°Å UI »çÀÌÆ®¸¦ ÀÚµ¿À¸·Î ¸¸µé ¼ö ÀÖ½À´Ï´Ù. ´Ü¼øÇÑ ¿¹Á¦Áö¸¸ ½Ç¹«ÀûÀ¸·Î ²Ï Å« µµ¿òÀÌ µÉ °ÍÀ̶ó »ý°¢Çؼ Çѱ¹¾îÆÇ Æ¯º°ºÎ·ÏÀ¸·Î Ãß°¡Çß½À´Ï´Ù.
ÄÚµùµµ ±×·¸Áö¸¸ ¹ø¿ªµµ ´Ã º¼ ¶§¸¶´Ù °³¼±Á¡ÀÌ ´«¿¡ º¸ÀÔ´Ï´Ù. ¾Æ¸¶ ¿ø¼¸¦ ÀÛ¼ºÇÑ ÀúÀڵ鵵 ¸¶Âù°¡ÁöÀÏ °Ì´Ï´Ù. ¹ø¿ªÀÚ´Â ÀÏÂ÷ÀûÀ¸·Î´Â ¿ø¼¸¦ ¿ì¸®±Û·Î ¿Å±â´Â ÀÏÀ» ÇÏ´Â »ç¶÷ÀÌÁö¸¸, ÈǸ¢ÇÑ ¹ø¿ªÀÚ´Â ¸ÕÀú µ¶ÀÚÀÇ ÀÔÀå¿¡¼ ¿ø¼¸¦ ÀÐ°í ºÒÆíÇß´ø Á¡À» ã¾Æ °³¼±ÇÏ°í ÃÖÁ¾ µ¶ÀÚ¿¡°Ô´Â ´õ ³ªÀº °á°ú¹°À» º¸¿©ÁÖ´Â »ç¶÷À̶ó°í »ý°¢ÇÕ´Ï´Ù. À̹ø¿¡µµ ¸ðÀÚ¶÷ÀÌ ÀÖ°ÚÁö¸¸ ÈǸ¢ÇÑ ¹ø¿ªÀÚ Èä³»¶óµµ ³»º¸°í ½Í¾î¼ ¿ø¼º¸´Ù ³ªÀº ¿ª¼¸¦ ¸ñÇ¥·Î ¹ø¿ª ÀÛ¾÷À» Çß½À´Ï´Ù. ¸ðÂÉ·Ï µ¶ÀںеéÀÌ Àо°¡½Ã¸é¼ ¸¶Ä¡ ¾ÖÃʺÎÅÍ Çѱ۷Π¾²¿©Áø Ã¥ÀÎ °Íó·³ ¼ú¼ú ÀÐÀ¸½Ç ¼ö Àֱ⸦ ¿å½É³»¾î ¹Ù¶óº¾´Ï´Ù.
-
-
[1ºÎ] OpenAPI Çü½ÄÀ¸·Î ±âÁ¸ Á¦Ç°ÀÇ API ±â¼úÇØ º¸±â
1Àå API¿Í OpenAPI ¼Ò°³
__1.1 API »ýÅ°è¶õ?
__1.2 API ±â¼úÇϱâ
____1.2.1 ºê¸®ÁþÀÇ ¾÷¹«
____1.2.2 ºê¸®Áþ ÇعýÀÇ ÀáÀç·Â
__1.3 OpenAPI¶õ?
____1.3.1 OpenAPI Á¤ÀǼ ¿¹Á¦
__1.4 OpenAPI Á¤ÀǼ´Â ¾îµð¿¡ »ç¿ëÇÏ´Â °ÍÀÌ ÁÁÀ»±î?
__1.5 ½º¿þ°Å¶õ?
__1.6 REST¶õ?
__1.7 OpenAPI´Â ¾ðÁ¦ »ç¿ëÇϴ°¡?
____1.7.1 API »ç¿ëÀÚ
____1.7.2 API Á¦°øÀÚ
____1.7.3 API ¼³°èÀÚ
__1.8 ÀÌ Ã¥ÀÇ ±¸¼º
__1.9 Á¤¸®
2Àå API ¿äû Áغñ
__2.1 ¹®Á¦ Á¤ÀÇ
____2.1.1 Á÷ÆÇÀå API °³¿ä
____2.1.2 Á÷ÆÇÀå APIÀÇ Ã³À½ µÎ °¡Áö ÀÛ¾÷
__2.2 Æ÷½ºÆ®¸Ç Áغñ
__2.3 Á÷ÆÇÀå API
__2.4 Èı⠸ñ·Ï Á¶È¸
____2.4.1 GET ¿äû ±¸¼º
____2.4.2 È®ÀÎ
__2.5 Èı⠳²±â±â
____2.5.1 POST ¿äû ±¸¼º
____2.5.2 È®ÀÎ
__2.6 ¿¬½À
____2.6.1 °í¾çÀÌ¿¡ °üÇÑ Áø½Ç API
____2.6.2 ¹Ì´Ï¸Ö ¾Æ¹ÙŸ API
____2.6.3 ´ö´ö°í °Ë»ö ¿£Áø API
____2.6.4 ÇØÀû Àº¾î API
__2.7 ¿ë»ç¸¦ À§ÇÑ HTTP
__2.8 Á¤¸®
3Àå OpenAPI Á¤ÀǼ ùÀλó
__3.1 ¹®Á¦ Á¤ÀÇ
__3.2 OpenAPI ¸í¼¼ ¼Ò°³
__3.3 YAML ÈȾ±â
___3.3.1 JSON¿¡¼ YAML·Î
__3.4 GET ¿¬»ê ±â¼úÇϱâ
__3.5 GET ¿¬»ê È®Àå...
__3.6 Á¤¸®
4Àå ½º¿þ°Å ¿¡µðÅÍ·Î OpenAPI Á¤ÀǼ ÀÛ¼º
__4.1 ½º¿þ°Å ¿¡µðÅÍ ¼Ò°³
___4.1.1 ¿¡µðÅÍ ÆгÎ
___4.1.2 UI ¹®¼ ÆгÎ
___4.1.3 µµ±¸ ¸Þ´º
___4.1.4 ÀúÀå
__4.2 ½º¿þ°Å ¿¡µðÅÍ¿¡¼ OpenAPI Á¤ÀǼ ÀÛ¼º
___4.2.1 À¯È¿ÇÑ ¹Ì´Ï OpenAPI Á¤ÀǼ
___4.2.2 ½º¿þ°Å ¿¡µðÅÍ¿¡¼ OpenAPI Á¤ÀǼ ÀÛ¼º
___4.2.3 °ËÁõ
__4.3 GET /reviews Ãß°¡
__4.4 API È£Ãâ
___4.4.1 GET /reviews È£Ãâ
___4.4.2 OpenAPI Á¤ÀǼ¿¡ ¼¹ö Á¤º¸ Ãß°¡
___4.4.3 GET /reviews ´Ù½Ã È£Ãâ
__4.5 Á¤¸®
5Àå API ÀÀ´ä ±â¼úÇϱâ
__5.1 HTTP ÀÀ´ä
__5.2 ¹®Á¦ Á¤ÀÇ
__5.3 ³î¶ó¿î µ¥ÀÌÅÍ ½ºÅ°¸¶ÀÇ ¼¼°è
__5.4 JSON ½ºÅ°¸¶
___5.4.1 type Çʵå
___5.4.2 °´Ã¼¿¡ Çʵå Ãß°¡
___5.4.3 minimum°ú maximum
___5.4.4 number¿Í integer
__5.5 »óÅ ÄÚµå
__5.6 ¹Ìµð¾î ŸÀÔ(MIME)
__5.7 GET /reviews ÀÀ´ä ±â¼úÇϱâ
___5.7.1 ÃÊ¹Ì´Ï ÀÀ´ä
___5.7.2 GET /reviews 200 ÀÀ´ä º»¹®
___5.7.3 ÀÀ´ä º»¹®¿¡ rating Çʵå Ãß°¡
___5.7.4 message, uuid, userId Çʵå Ãß°¡
__5.8 Á¤¸®
6Àå ÀÚ¿ø »ý¼º
__6.1 ¹®Á¦ Á¤ÀÇ
__6.2 POST /reviews¿Í ¿äû º»¹® ±â¼úÇϱâ
___6.2.1 ¿äû º»¹®
___6.2.2 requestBodyÀÇ ½ºÅ°¸¶
__6.3 »õ Èı⠻ý¼º
___6.3.1 ¿¹½Ã Ãß°¡·Î try-it-out ±â´É °³¼±
__6.4 °æ·Î ÆĶó¹ÌÅ͸¦ Æ÷ÇÔÇÑ GET /reviews/{reviewId} ±â¼úÇϱâ
___6.4.1 °æ·Î ÆĶó¹ÌÅÍ
___6.4.2 reviewId °æ·Î ÆĶó¹ÌÅÍ ±â¼úÇϱâ
__6.5 Èı⠻ý¼º È®ÀÎ
__6.6 Á¤¸®
7Àå ÀÎÁõ°ú Àΰ¡
__7.1 ¹®Á¦ Á¤ÀÇ
__7.2 ÀÎÁõ Áغñ
___7.2.1 µµÀü °úÁ¦: POST /users ±â¼úÇϱâ
___7.2.2 µµÀü °úÁ¦: POST /tokens ±â¼úÇϱâ
___7.2.3 Çعý: Á¤ÀǼ ³»¿ë º¯°æ
___7.2.4 »ç¿ëÀÚ ¹× ÅäÅ« »ý¼º ±â´É È®ÀÎ
__7.3 Authorization Çì´õ Ãß°¡
___7.3.1 OpenAPIÀÇ Àΰ¡ ó¸® ¹æ½Ä
___7.3.2 OpenAPI 3.0.x¿¡¼ Áö¿øÇÏ´Â Àΰ¡(º¸¾È) ¹æ½Ä
___7.3.3 º¸¾È ½ºÅ´¿¡ Authorization Çì´õ Ãß°¡
___7.3.4 POST /reviews¿¡ º¸¾È ¿ä±¸»çÇ× Ãß°¡
___7.3.5 º¸¾È ±â´É µ¿ÀÛ È®ÀÎ
__7.4 ¼±ÅÃÀûÀ¸·Î º¸¾È Àû¿ë
__7.5 ´Ù¸¥ ¹æ½ÄÀÇ º¸¾È ½ºÅ´
__7.6 º¸¾È ½ºÅ´À» Àû¿ëÇÏ´Â ÀϹÝÀûÀÎ ¹æ¹ý
__7.7 Á¤¸®
8Àå API ¹®¼ Áغñ¿Í È£½ºÆÃ
__8.1 ¹®Á¦ Á¤ÀÇ
__8.2 API Á¤ÀǼ¿¡ ¸ÞŸµ¥ÀÌÅÍ Ãß°¡
__8.3 ¸¶Å©´Ù¿îÀ¸·Î ¼³¸í ÀÛ¼º
___8.3.1 ¸¶Å©´Ù¿î ±âÃÊ
___8.3.2 Á÷ÆÇÀå API Á¤ÀǼ¿¡ ¸¶Å©´Ù¿î ¼³¸í Ãß°¡
__8.4 ű׷Π¿¬»ê ±×·ì Áþ±â
___8.4.1 GET /reviews ¿¬»ê¿¡ ÅÂ±× Ãß°¡
___8.4.2 ű׿¡ ¼³¸í Ãß°¡
___8.4.3 ³ª¸ÓÁö ¿¬»ê¿¡ ÅÂ±× Ãß°¡
__8.5 Netlify.com°ú ½º¿þ°Å UI·Î API ¹®¼ È£½ºÆÃ
___8.5.1 OpenAPI Á¤ÀǼ·Î ½º¿þ°Å UI Áغñ
___8.5.2 Netlify.com¿¡¼ È£½ºÆÃ
__8.6 1ºÎ ¸¶¹«¸®
__8.7 Á¤¸®
[2ºÎ] OpenAPI¿Í ½º¿þ°Å¸¦ È°¿ëÇÑ API ¼³°è ¿ì¼± ¹æ½Ä
9Àå À¥ ¾ÖÇø®ÄÉÀÌ¼Ç ¼³°è
__9.1 Æê½ÃÅÍ ¾ÆÀ̵ð¾î
__9.2 Æê½ÃÅÍ ÇÁ·ÎÁ§Æ® Âø¼ö
___9.2.1 Ãß°¡ ¿ä±¸»çÇ×
___9.2.2 ÆÀ ±¸Á¶
___9.2.3 API Á᫐ ¾ÆÅ°ÅØó
___9.2.4 °èȹ
__9.3 µµ¸ÞÀÎ ¸ðµ¨¸µ°ú API
___9.3.1 API¿¡ »ç¿ëÇÒ µµ¸ÞÀÎ ¸ðµ¨¸µ
___9.3.2 Á÷ÆÇÀå API µ¹¾Æº¸±â
__9.4 Æê½ÃÅÍ µµ¸ÞÀÎ ¸ðµ¨
___9.4.1 ¸ðµ¨¿¡ »ç¿ëµÇ´Â °³³ä
___9.4.2 »ç¿ëÀÚ ¸ðµ¨
___9.4.3 ±¸ÀÎ °ø°í¿Í ¹Ý·Á°ß ¸ðµ¨
__9.5 Æê½ÃÅÍ »ç¿ëÀÚ ½ºÅ丮
___9.5.1 »ç¿ëÀÚ ½ºÅ丮¶õ ¹«¾ùÀΰ¡?
___9.5.2 »ç¿ëÀÚ ½ºÅ丮 ¼öÁý
___9.5.3 »ç¿ëÀÚ ½ºÅ丮 ¸ÅÇÎ
__9.6 Á¤¸®
10Àå OpenAPI¸¦ »ç¿ëÇÑ API ¼³°è
__10.1 ¹®Á¦
___10.1.1 µµ¸ÞÀÎ ¸ðµ¨À» OpenAPI·Î Àüȯ
___10.1.2 Àç»ç¿ë¼º º¸Àå
__10.2 ½ºÅ°¸¶ »ý¼º
___10.2.1 ½ºÅ°¸¶¸¦ Æ÷ÇÔÇÏ´Â OpenAPI ÆÄÀÏ
___10.2.2 °øÅë ½ºÅ°¸¶ ÂüÁ¶
___10.2.3 User ½ºÅ°¸¶
___10.2.4 Job ½ºÅ°¸¶
___10.2.5 Dog ½ºÅ°¸¶
___10.2.6 JobApplication ½ºÅ°¸¶
__10.3 API ¿¬»ê°ú CRUD
___10.3.1 API ¿äû°ú ÀÀ´ä Á¤ÀÇ
___10.3.2 »ç¿ëÀÚ ½ºÅ丮¿Í CRUD ¼³°è
__10.4 Æê½ÃÅÍ API
___10.4.1 User ½ºÅ°¸¶¿¡ ÇÊ¿äÇÑ ¿¬»ê
___10.4.2 Job ½ºÅ°¸¶¿¡ ÇÊ¿äÇÑ ¿¬»ê
___10.4.3 JobApplication ½ºÅ°¸¶¿¡ ÇÊ¿äÇÑ ¿¬»ê
__10.5 Á¤¸®
11Àå API ¼³°è ¿ì¼± ¹æ½Ä¿¡ º¯°æ ¿öÅ©Ç÷Π±¸Ãà
__11.1 ¹®Á¦
__11.2 º¯°æ ³íÀÇ¿Í ´ëÀÀ
__11.3 ¿öÅ©Ç÷Π¿£ÁøÀ¸·Î¼ÀÇ ±êÇãºê
___11.3.1 ´ÜÀÏ Áø½Ç Ãâó
___11.3.2 º¯°æ Á¦¾È
___11.3.3 º¯°æ ¼ö¿ë
___11.3.4 º¯°æ ºñ±³ È®ÀÎ
__11.4 ±êÇãºê ¿öÅ©Ç÷ΠÅëÇÕ
___11.4.1 ±êÇãºê¿Í Áø½ÇÀÇ Ãâó ±¸¼º
___11.4.2 ±êÇãºê ¿öÅ©Ç÷Π´Ü°è
__11.5 ¿öÅ©Ç÷Π½Ç¹«
___11.5.1 DELETE /jobs/{id} Ãß°¡ Á¦¾È
___11.5.2 º¯°æ °ËÅä ¹× ¼ö¿ë
___11.5.3 ¿À·¡µÈ ºê·£Ä¡¿Í ÃֽŠºê·£Ä¡ ºñ±³
___11.5.4 11Àå¿¡¼ ¼öÇàÇÑ ³»¿ë
__11.6 Á¤¸®
12Àå ÇÁ·ÐÆ®¿£µå ÄÚµå ±¸Çö°ú º¯°æ ´ëÀÀ
__12.1 ¹®Á¦
__12.2 ÇÁ¸®Áò ¸ñ ¼¹ö ±¸¼º
___12.2.1 ÇÁ¸®Áò ¼³Ä¡
___12.2.2 ÇÁ¸®Áò µ¿ÀÛ È®ÀÎ
__12.3 ¸ñ ¼¹ö¸¦ ¹ÙÅÁÀ¸·Î ÇÁ·ÐÆ®¿£µå °³¹ß
___12.3.1 OpenAPI Á¤ÀǼ¿¡ ¿¹Á¦ Ãß°¡
___12.3.2 ÇÁ¸®Áò¿¡ examples Àû¿ë
__12.4 ´©¶ôµÈ API ¿¬»ê ½Äº°
___12.4.1 »õ ¿¬»ê Ãß°¡ °ËÅä
___12.4.2 »õ ¿¬»ê ¼³°è
___12.4.3 ÇÁ¸®ÁòÀ¸·ÎºÎÅÍ ¹Ýȯ¹ÞÀ» ¸ñ µ¥ÀÌÅÍ ¼±Á¤
___12.4.4 º¯°æ Á¦¾È
___12.4.5 curl ¿¹Á¦
__12.5 Á¤¸®
13Àå Node.js¿Í ½º¿þ°Å ÄÚµåÁ¨À¸·Î ¹é¿£µå ±¸Ãà
__13.1 ¹®Á¦
__13.2 ½º¿þ°Å ÄÚµåÁ¨ ¼Ò°³
___13.2.1 Ŭ¶óÀ̾ðÆ® ÄÚµå »ý¼º
___13.2.2 ¼¹ö ÄÚµå »ý¼º
___13.2.3 ½º¿þ°Å Á¦³Ê·¹ÀÌÅÍ
__13.3 ¹é¿£µå ±¸Á¶
___13.3.1 ¹é¿£µå ÄÚµå »ý¼º
___13.3.2 ¹é¿£µå ±¸Á¶ ºÐ¼®
___13.3.3 OpenAPI ¼öÁ¤ ³»¿ë
__13.4 ¹é¿£µå OpenAPI ¼öÁ¤
___13.4.1 operation ID Ãß°¡
___13.4.2 API ¿¬»ê¿¡ ÅÂ±× ÁöÁ¤
___13.4.3 ¹é¿£µå ½ºÅÓ Àç»ý¼º
__13.5 ¹é¿£µå ÄÚµå ½ÇÇà°ú Å×½ºÆ®
___13.5.1 Æ÷½ºÆ®¸ÇÀ¸·Î Å×½ºÆ®
___13.5.2 ÀԷ°ª °ËÁõ Å×½ºÆ®
___13.5.3 ÇÁ¸®ÁòÀ¸·Î °á±£°ª °ËÁõ
__13.6 ¸ù±¸½º·Î µ¥ÀÌÅͺ£À̽º ÀúÀå
___13.6.1 API ¼öÁ¤
___13.6.2 ¸ù°íµðºñ »ç¿ë Áغñ
___13.6.3 ¸ù±¸½º ¼³Á¤
___13.6.4 ¸ðµ¨ »ý¼º
__13.7 API ¸Þ¼Òµå ±¸Çö
__13.8 Á¤¸®
14Àå À¥ ¾ÖÇø®ÄÉÀÌ¼Ç ÅëÇÕ ¹× Ãâ½Ã
__14.1 ¹®Á¦
___14.1.1 ÀÎÁõ
___14.1.2 ÄÚµå Á¶Á÷
___14.1.3 ¹é¿£µå¿Í ÇÁ·ÐÆ®¿£µå ÄÄÆ÷³ÍÆ®¸¦ ÇÔ²² Á¦°ø
__14.2 Àΰ¡ ±¸Çö
___14.2.1 º¸¾È ½ºÅ´ »ý¼º
___14.2.2 ¡®Login¡¯ ÇàÀ§ Ãß°¡
___14.2.3 ¿¬»ê º¸¾È Á¤ÀÇ
__14.3 ¸®Æ÷ÁöÅ͸® °ü¸®
___14.3.1 ±âÁ¸ ±¸Á¶ À¯Áö
___14.3.2 °øÀ¯ ±ê ¸®Æ÷ÁöÅ͸® »ç¿ë
___14.3.3 ÄÚµå¿Í API Á¤ÀǼ¸¦ ÇϳªÀÇ ¸®Æ÷ÁöÅ͸®¿¡ ÅëÇÕ
___14.3.4 °áÁ¤ ¹× ¸®ÆÑÅ͸µ
__14.4 ÅëÇÕ À¥ ¼¹ö ±¸¼º
___14.4.1 URL ¼³°è
___14.4.2 ¼¹ö ±¸¼º
__14.5 Á¤¸®
[3ºÎ] Á¦Ç° Ãâ½Ã ÀÌÈÄ API È®Àå°ú ÁøÈ
15Àå 2Â÷ API ¼³°è
__15.1 ù ¹ø° °³¹ß ½ºÇÁ¸°Æ® °ËÅä
__15.2 ´ÙÀ½ ½ºÇÁ¸°Æ® °èȹ
__15.3 »õ ±â´É Áغñ
___15.3.1 µµ¸ÞÀÎ ¸ðµ¨ Àç°ËÅä
___15.3.2 »ç¿ëÀÚ ½ºÅ丮 °ËÅä
__15.4 °³¹ßÀÚ °æÇè °³¼±
___15.4.1 ÀÏ°ü¼º
___15.4.2 ¿¡·¯ ó¸®
___15.4.3 ÀԷ°ª À¯È¿¼º °ËÁõ
___15.4.4 ¹öÀü °ü¸®¿Í ÁøÈ
__15.5 Á¤¸®
16Àå OpenAPI ÇÕ¼ºÀ» »ç¿ëÇÑ ½ºÅ°¸¶ ¼³°è
__16.1 ¹®Á¦
__16.2 µµ¸ÞÀÎ ¸ðµ¨ ´ÙÇü¼º°ú »ó¼Ó
__16.3 ½ºÅ°¸¶ ¾÷µ¥ÀÌÆ®
___16.3.1 Pet ½ºÅ°¸¶
___16.3.2 Dog ½ºÅ°¸¶
___16.3.3 Cat ½ºÅ°¸¶
__16.4 OpenAPIÀÇ ´ÙÇü¼º°ú »ó¼Ó
___16.4.1 Dog ½ºÅ°¸¶¿Í Cat ½ºÅ°¸¶ ¾È¿¡¼ ÇÕ¼º
___16.4.2 Pet ½ºÅ°¸¶ ¾È¿¡¼ ÇÕ¼º
__16.5 OpenAPI ±¸ºÐÀÚ Ãß°¡
__16.6 Á¤¸®
17Àå Ä÷º¼Ç ¿£µåÆ÷ÀÎÆ®¿¡ ÇÊÅÍ¿Í ÆäÀÌ¡ Àû¿ë
__17.1 ¹®Á¦
__17.2 ÇÊÅ͸µ ¼³°è
___17.2.1 ÇÁ·ÎÁ§¼Ç ÇÊÅÍ
___17.2.2 ¼¿·º¼Ç ÇÊÅÍ
___17.2.3 Áßø ½ºÅ°¸¶ ó¸®
___17.2.4 Äõ¸® ¾ð¾î
___17.2.5 Ư¼ö °ü·Ê
__17.3 Æê½ÃÅÍ ÇÊÅ͸µ
___17.3.1 ÇÊÅ͸µ ±âÁØ ÇÊµå ¼±Á¤
___17.3.2 OpenAPI¿¡ ÇÊÅ͸µ Àû¿ë
___17.3.3 ÇÊÅÍ Æ÷ÇÔ ¿äû
__17.4 ÆäÀÌ¡ ¼³°è
___17.4.1 ¿ÀÇÁ¼Â ±â¹Ý, ÆäÀÌÁö ±â¹Ý ÆäÀÌ¡
___17.4.2 Ä¿¼ ±â¹Ý ÆäÀÌ¡
__17.5 Æê½ÃÅÍ¿¡ ÆäÀÌ¡ Àû¿ë
___17.5.1 OpenAPI¿¡ ÆäÀÌ¡ Àû¿ë
___17.5.2 ¿äû ¿¹Á¦ È®Àå
__17.6 Á¤·Ä ¼³°è
___17.6.1 ´ÜÀÏ Çʵå Á¤·Ä
___17.6.2 ´ÙÁß Çʵå Á¤·Ä
___17.6.3 ÆĶó¹ÌÅÍ Å¸ÀÔ ÀÏ°ü¼º
__17.7 Æê½ÃÅÍ¿¡ Á¤·Ä Àû¿ë
___17.7.1 Á¤·Ä Çʵå
___17.7.2 Á¤·Ä ÆĶó¹ÌÅÍ ¼³°è
___17.7.3 OpenAPI Á¤ÀǼ¿¡ Á¤·Ä ±â´É Ãß°¡
___17.7.4 ÇÊÅ͸µ, ÆäÀÌ¡, Á¤·ÄÀÌ ¸ðµÎ Àû¿ëµÈ ¿äû ¿¹Á¦
__17.8 Á¤¸®
18Àå problem+jsonÀ» È°¿ëÇÑ ¿¹¿Ü ó¸®
__18.1 ¹®Á¦ Á¤ÀÇ
__18.2 ¿¡·¯ ºÐ·ù
___18.2.1 ½ÇÆÐ »óȲ ã±â
___18.2.2 °øÅë ¿¡·¯ ÆÐÅÏ
__18.3 ¿¡·¯ ÀÀ´ä ¿ä±¸»çÇ×
__18.4 OAS µµ±¸ Çü½Ä
__18.5 problem+json Çü½Ä
__18.6 OpenAPI Á¤ÀǼ¿¡ ¿¡·¯ ÀÀ´ä Ãß°¡
___18.6.1 ¿¡·¯ ½ºÅ°¸¶ »ý¼º
___18.6.2 ¿¬»ê¿¡ ¿¡·¯ ÀÀ´ä Ãß°¡
__18.7 ¿¡·¯ ó¸® °¡À̵å
___18.7.1 ÇÁ·ÐÆ®¿£µå °³¹ß
___18.7.2 ¹é¿£µå °³¹ß
__18.8 Á¤¸®
19Àå °í±Þ JSON ½ºÅ°¸¶¸¦ È°¿ëÇÑ ÀԷ°ª À¯È¿¼º °ËÁõ
__19.1 ¹®Á¦ Á¤ÀÇ
__19.2 À¯È¿¼º °ËÁõ ¼¼ºÎ ±â´É
___19.2.1 readOnly, writeOnly ÇÁ·ÎÆÛƼ
___19.2.2 ¼ýÀÚ Á¦¾à»çÇ× °Á¦
___19.2.3 ¹®ÀÚ¿ Çü½Ä °Á¦
___19.2.4 ¹è¿ Á¦¾à»çÇ× °Á¦
___19.2.5 ¿°ÅÇü Á¤ÀÇ
___19.2.6 Çʼö ÇÁ·ÎÆÛƼ¿Í ¼±Åà ÇÁ·ÎÆÛƼ ¸ñ·Ï
___19.2.7 ±âº»°ª ÁöÁ¤
__19.3 Æê½ÃÅÍ ½ºÅ°¸¶ ¾÷µ¥ÀÌÆ®
___19.3.1 User ½ºÅ°¸¶
___19.3.2 Job ½ºÅ°¸¶
___19.3.3 JobApplication ½ºÅ°¸¶
___19.3.4 Pet, Dog, Cat ½ºÅ°¸¶
__19.4 Á¤¸®
20Àå API ¹öÀü °ü¸®¿Í Áß´ë º¯°æ ó¸®
__20.1 ¹®Á¦ Á¤ÀÇ
__20.2 Áß´ë º¯°æÀ̶õ?
__20.3 Áß´ë º¯°æ Ãâ½Ã
___20.3.1 Áß´ë º¯°æ Á¶À²
___20.3.2 API ¹öÀü °ü¸®
___20.3.3 ¹Ìµð¾î ŸÀÔÀ» È°¿ëÇÑ ½ºÅ°¸¶ ¹öÀü ±¸ºÐ
___20.3.4 ±â´É Ãß°¡/»èÁ¦ ¿¹°í
__20.4 Á¤¸®
21Àå API Ãâ½Ã Àü üũ¸®½ºÆ®
__21.1 °ø°³ APIÀÇ ÀåÁ¡°ú ´ÜÁ¡
__21.2 üũ¸®½ºÆ®
__21.3 API Á¤»ó µ¿ÀÛ
___21.3.1 API ´ÜÀ§ Å×½ºÆ®
___21.3.2 Á¾´Ü °£ Å×½ºÆ®
__21.4 ¹®¼È
__21.5 API ÀÏ°ü¼º È®º¸
__21.6 À¯È¿¼º °ËÁõ°ú ¿¡·¯ º¸°í
__21.7 API ·Îµå¸Ê°ú À妽º °ø°³
__21.8 º¯°æ Àü·«
__21.9 º¸¾È °³¼±
__21.10 API ¸ð´ÏÅ͸µ
___21.10.1 ÁöÇ¥ ¼öÁý ±¸¼º
__21.11 API Ãâ½Ã
___21.12 Á¤¸®
ºÎ·Ï A ½º¿þ°Å 2.0, OpenAPI 3.0, OpenAPI 3.1
ºÎ·Ï B [Çѱ¹¾îÆÇ Æ¯º°ºÎ·Ï] ½ºÇÁ¸µ ºÎÆ® À¥¼ºñ½º¿¡ ½º¿þ°Å¸¦ ÀÔÇô È°¿ëÇÏ´Â ¹æ¹ý
-
-
-
|
¿À¸í¿î [Àú]
|
|
-
¾ðÁ¦³ª ¹ö±×¿Í ¾¾¸§ÇÏ´Â °³¹ßÀÚ´Ù. ¹ø¿ªÀ» ÅëÇØ °³¹ßÀÚ »ýÅ°迡 Á¶±ÝÀÌ¶óµµ º¸ÅÆÀÌ µÇ°íÀÚ ³ë·ÂÇÑ´Ù. ¡º½ºÇÁ¸µ 5.0 ¸¶ÀÌÅ©·Î¼ºñ½º 2/e¡»(¿¡ÀÌÄÜÃâÆÇ, 2018), ¡ºD3.js ½Ç½Ã°£ µ¥ÀÌÅÍ ½Ã°¢È¡»(¿¡ÀÌÄÜÃâÆÇ, 2015), ¡ºÅ¬¶ó¿ìµå ³×ÀÌƼºê ÀÚ¹Ù¡»(Ã¥¸¸, 2018), ¡º¿£ÅÍÇÁ¶óÀÌÁî µ¥ÀÌÅÍ Ç÷§Æû ±¸Ãà¡»(Ã¥¸¸, 2020) µîÀ» ¹ø¿ªÇßÀ¸¸ç, ¾ÕÀ¸·Îµµ ÀûÀº ¾çÀÌ¶óµµ ²ÙÁØÈ÷ ¹ø¿ª ÀÛ¾÷À» À̾ »ý°¢ÀÌ´Ù. https://homoefficio.github.io/¿¡¼ °³¹ß °ü·Ã Áö½ÄÀ» Á¤¸®Çؼ ³ª´©°í ÀÖ°í, Àâ´ÙÇÑ ¹®Á¦ ÇØ°á ±â·ÏÀ» https://github.com/HomoEfficio/dev-tips¿¡ ³²±â¸é¼ ±â¾ï·Â °¨Å𸦠±â·Ï·Â ÁõÁøÀ¸·Î ¸Þ²Ù°í ÀÖ´Ù. ÇöÀç ³×À̹öÁ¦Æ®¿¡¼ ±Û·Î¹ú ¸ÞŸ¹ö½º ¼ºñ½ºÀÎ Á¦ÆäÅä(Zepeto)¸¦ ¸¸µé¸ç ¹é¹ß °³¹ßÀÚÀÇ ²ÞÀ» À̾°í ÀÖ´Ù.
-
-
Àüü 0°³ÀÇ ±¸¸ÅÈıⰡ ÀÖ½À´Ï´Ù.
|
ÀÎÅÍÆÄÅ©µµ¼´Â °í°´´ÔÀÇ ´Ü¼ø º¯½É¿¡ ÀÇÇÑ ±³È¯°ú ¹ÝÇ°¿¡ µå´Â ºñ¿ëÀº °í°´´ÔÀÌ ÁöºÒÄÉ µË´Ï´Ù.
´Ü, »óÇ°À̳ª ¼ºñ½º ÀÚüÀÇ ÇÏÀÚ·Î ÀÎÇÑ ±³È¯ ¹× ¹ÝÇ°Àº ¹«·á·Î ¹ÝÇ° µË´Ï´Ù. |
|
±³È¯ ¹× ¹ÝÇ°ÀÌ °¡´ÉÇÑ °æ¿ì |
»óÇ°À» °ø±Þ ¹ÞÀº ³¯·ÎºÎÅÍ 7ÀÏÀ̳» °¡´É
°ø±Þ¹ÞÀ¸½Å »óÇ°ÀÇ ³»¿ëÀÌ Ç¥½Ã, ±¤°í ³»¿ë°ú ´Ù¸£°Å³ª ´Ù¸£°Ô ÀÌÇàµÈ °æ¿ì¿¡´Â °ø±Þ¹ÞÀº ³¯·ÎºÎÅÍ 3°³¿ù À̳», ȤÀº ±×»ç½ÇÀ» ¾Ë°Ô µÈ ³¯ ¶Ç´Â ¾Ë ¼ö ÀÖ¾ú´ø ³¯·ÎºÎÅÍ 30ÀÏ À̳»
»óÇ°¿¡ ¾Æ¹«·± ÇÏÀÚ°¡ ¾ø´Â °æ¿ì ¼ÒºñÀÚÀÇ °í°´º¯½É¿¡ ÀÇÇÑ ±³È¯Àº »óÇ°ÀÇ Æ÷Àå»óÅ µîÀÌ ÀüÇô ¼Õ»óµÇÁö ¾ÊÀº °æ¿ì¿¡ ÇÑÇÏ¿© °¡´É |
|
±³È¯ ¹× ¹ÝÇ°ÀÌ ºÒ°¡´ÉÇÑ °æ¿ì |
±¸¸ÅÈ®Á¤ ÀÌÈÄ(¿ÀǸ¶ÄÏ»óÇ°¿¡ ÇÑÇÔ)
°í°´´ÔÀÇ Ã¥ÀÓ ÀÖ´Â »çÀ¯·Î »óÇ° µîÀÌ ¸ê½Ç ¶Ç´Â ÈÑ¼ÕµÈ °æ¿ì
(´Ü, »óÇ°ÀÇ ³»¿ëÀ» È®ÀÎÇϱâ À§ÇÏ¿© Æ÷Àå µîÀ» ÈѼÕÇÑ °æ¿ì´Â Á¦¿Ü)
½Ã°£ÀÌ Áö³²¿¡ µû¶ó ÀçÆǸŰ¡ °ï¶õÇÒ Á¤µµ·Î ¹°Ç°ÀÇ °¡Ä¡°¡ ¶³¾îÁø °æ¿ì
Æ÷Àå °³ºÀµÇ¾î »óÇ° °¡Ä¡°¡ ÈÑ¼ÕµÈ °æ¿ì |
|
´Ù¹è¼ÛÁöÀÇ °æ¿ì ¹ÝÇ° ȯºÒ |
´Ù¹è¼ÛÁöÀÇ °æ¿ì ´Ù¸¥ Áö¿ªÀÇ ¹ÝÇ°À» µ¿½Ã¿¡ ÁøÇàÇÒ ¼ö ¾ø½À´Ï´Ù.
1°³ Áö¿ªÀÇ ¹ÝÇ°ÀÌ ¿Ï·áµÈ ÈÄ ´Ù¸¥ Áö¿ª ¹ÝÇ°À» ÁøÇàÇÒ ¼ö ÀÖÀ¸¹Ç·Î, ÀÌÁ¡ ¾çÇØÇØ Áֽñ⠹ٶø´Ï´Ù. |
|
Áß°í»óÇ°ÀÇ ±³È¯ |
Áß°í»óÇ°Àº Á¦ÇÑµÈ Àç°í ³»¿¡¼ ÆǸŰ¡ ÀÌ·ç¾îÁö¹Ç·Î, ±³È¯Àº ºÒ°¡´ÉÇÕ´Ï´Ù. |
|
¿ÀǸ¶ÄÏ »óÇ°ÀÇ È¯ºÒ |
¿ÀǸ¶ÄÏ»óÇ°¿¡ ´ëÇÑ Ã¥ÀÓÀº ¿øÄ¢ÀûÀ¸·Î ¾÷ü¿¡°Ô ÀÖÀ¸¹Ç·Î, ±³È¯/¹ÝÇ° Á¢¼ö½Ã ¹Ýµå½Ã ÆǸÅÀÚ¿Í ÇùÀÇ ÈÄ ¹ÝÇ° Á¢¼ö¸¦ ÇϼžßÇϸç, ¹ÝÇ°Á¢¼ö ¾øÀÌ ¹Ý¼ÛÇϰųª, ¿ìÆíÀ¸·Î º¸³¾ °æ¿ì »óÇ° È®ÀÎÀÌ ¾î·Á¿ö ȯºÒÀÌ ºÒ°¡´ÉÇÒ ¼ö ÀÖÀ¸´Ï À¯ÀÇÇϽñ⠹ٶø´Ï´Ù. |
|
|
|
¹è¼Û¿¹Á¤ÀÏ ¾È³» |
ÀÎÅÍÆÄÅ© µµ¼´Â ¸ðµç »óÇ°¿¡ ´ëÇØ ¹è¼Û¿Ï·á¿¹Á¤ÀÏÀ» À¥»çÀÌÆ®¿¡ Ç¥½ÃÇÏ°í ÀÖ½À´Ï´Ù.
|
<ÀÎÅÍÆÄÅ© Á÷¹è¼Û »óÇ°> |
»óÇ°Àº ¿ù~Åä¿äÀÏ ¿ÀÀü 10½Ã ÀÌÀü ÁÖ¹®ºÐ¿¡ ´ëÇÏ¿© ´çÀÏ Ãâ°í/´çÀÏ ¹è¼Û¿Ï·á¸¦ º¸ÀåÇÏ´Â »óÇ°ÀÔ´Ï´Ù. |
»óÇ°Àº ¼¿ïÁö¿ª/ÆòÀÏ ÁÖ¹®ºÐÀº ´çÀÏ Ãâ°í/ÀÍÀÏ ¹è¼Û¿Ï·á¸¦ º¸ÀåÇϸç,
¼¿ï¿ÜÁö¿ª/ÆòÀÏ ÁÖ¹®ºÐÀÇ °æ¿ì´Â ¿ÀÈÄ 6½Ã±îÁö ÁÖ¹®ºÐ¿¡ ´ëÇÏ¿© ÀÍÀÏ ¹è¼Û¿Ï·á¸¦ º¸ÀåÇÏ´Â »óÇ°ÀÔ´Ï´Ù.
(´Ü, ¿ù¿äÀÏÀº 12½Ã±îÁö ÁÖ¹®¿¡ ÇÑÇÔ)
|
»óÇ°Àº, ÀÔ°í¿¹Á¤ÀÏ(Á¦Ç°Ãâ½ÃÀÏ)+Åùè»ç¹è¼ÛÀÏ(1ÀÏ)¿¡ ¹è¼Û¿Ï·á¸¦ º¸ÀåÇÕ´Ï´Ù. |
~
»óÇ°Àº À¯ÅëƯ¼º»ó ÀÎÅÍÆÄÅ©¿¡¼ Àç°í¸¦ º¸À¯ÇÏÁö ¾ÊÀº »óÇ°À¸·Î ÁÖ¹®ÀÏ+±âÁØÃâ°íÀÏ+Åùè»ç¹è¼ÛÀÏ(1ÀÏ)¿¡ ¹è¼Û¿Ï·á¸¦ º¸ÀåÇÕ´Ï´Ù.(Åä/°øÈÞÀÏÀº ¹è¼Û±â°£¿¡ Æ÷ÇÔµÇÁö ¾Ê½À´Ï´Ù.)
¡Ø±âÁØÃâ°íÀÏ:ÀÎÅÍÆÄÅ©°¡ »óÇ°À» ¼ö±ÞÇÏ¿© ¹°·ùâ°í¿¡¼ Æ÷Àå/Ãâ°íÇϱâ±îÁö ¼Ò¿äµÇ´Â ½Ã°£
|
|
<¾÷ü Á÷Á¢¹è¼Û/¿ÀǸ¶ÄÏ »óÇ°> |
~
»óÇ°Àº ¾÷ü°¡ ÁÖ¹®À» È®ÀÎÇÏ°í, Ãâ°íÇϱâ±îÁö °É¸®´Â ½Ã°£ÀÔ´Ï´Ù. ÁÖ¹®ÀÏ+±âÁØÃâ°íÀÏ+Åùè»ç¹è¼ÛÀÏ(2ÀÏ)¿¡ ¹è¼Û¿Ï·á¸¦ º¸ÀåÇÕ´Ï´Ù.(Åä/°øÈÞÀÏÀº ¹è¼Û±â°£¿¡ Æ÷ÇÔµÇÁö ¾Ê½À´Ï´Ù.)
¡Ø5ÀÏÀ̳» Ãâ°í°¡ ½ÃÀÛµÇÁö ¾ÊÀ»½Ã, ¿ÀǸ¶ÄÏ »óÇ°Àº ÀÚµ¿À¸·Î ÁÖ¹®ÀÌ Ãë¼ÒµÇ¸ç, °í°´´Ô²² Ç°Àýº¸»ó±ÝÀ» Áö±ÞÇØ µå¸³´Ï´Ù.
|
|
|
¹è¼Ûºñ ¾È³» |
µµ¼(Áß°íµµ¼ Æ÷ÇÔ)¸¸ ±¸¸ÅÇϽøé : ¹è¼Ûºñ 2,000¿ø (1¸¸¿øÀÌ»ó ±¸¸Å ½Ã ¹«·á¹è¼Û) À½¹Ý/DVD¸¸ ±¸¸ÅÇϽøé : ¹è¼Ûºñ 1,500¿ø (2¸¸¿øÀÌ»ó ±¸¸Å ½Ã ¹«·á¹è¼Û)
ÀâÁö/¸¸È/±âÇÁÆ®¸¸ ±¸¸ÅÇϽøé : ¹è¼Ûºñ 2,000¿ø (2¸¸¿øÀÌ»ó ±¸¸Å ½Ã ¹«·á¹è¼Û)
µµ¼¿Í À½¹Ý/DVD¸¦ ÇÔ²² ±¸¸ÅÇϽøé : ¹è¼Ûºñ 1,500¿ø 1¸¸¿øÀÌ»ó ±¸¸Å ½Ã ¹«·á¹è¼Û)
µµ¼¿Í ÀâÁö/¸¸È/±âÇÁÆ®/Áß°íÁ÷¹è¼Û»óÇ°À» ÇÔ²² ±¸¸ÅÇϽøé : 2,000¿ø (1¸¸¿øÀÌ»ó ±¸¸Å ½Ã ¹«·á¹è¼Û)
¾÷üÁ÷Á¢¹è¼Û»óÇ°À» ±¸¸Å½Ã : ¾÷üº°·Î »óÀÌÇÑ ¹è¼Ûºñ Àû¿ë
* ¼¼Æ®»óÇ°ÀÇ °æ¿ì ºÎºÐÃë¼Ò ½Ã Ãß°¡ ¹è¼Ûºñ°¡ ºÎ°úµÉ ¼ö ÀÖ½À´Ï´Ù.
* ºÏÄ«Æ®¿¡¼ ¹è¼Ûºñ¾ø¾Ö±â ¹öÆ°À» Ŭ¸¯Çϼż, µ¿ÀϾ÷ü»óÇ°À» Á¶±Ý ´õ ±¸¸ÅÇϽøé, ¹è¼Ûºñ¸¦ Àý¾àÇÏ½Ç ¼ö ÀÖ½À´Ï´Ù.
|
|
Çؿܹè¼Û ¾È³» |
ÀÎÅÍÆÄÅ©µµ¼¿¡¼´Â ±¹³»¿¡¼ ÁÖ¹®ÇϽðųª ÇØ¿Ü¿¡¼ ÁÖ¹®ÇÏ¿© ÇØ¿Ü·Î ¹è¼ÛÀ» ¿øÇÏ½Ç °æ¿ì DHL°ú Ư¾àÀ¸·Î Ã¥Á¤µÈ ¿ä±ÝÇ¥¿¡
ÀÇÇØ °³ÀÎÀÌ ÀÌ¿ëÇÏ´Â °æ¿ìº¸´Ù ¹è¼Û¿ä±ÝÀ» Å©°Ô ³·Ã߸ç DHL(www.dhl.co.kr)·Î Çؿܹè¼Û ¼ºñ½º¸¦ Á¦°øÇÕ´Ï´Ù.
Çؿܹè¼ÛÀº µµ¼/CD/DVD »óÇ°¿¡ ÇÑÇØ ¼ºñ½ºÇÏ°í ÀÖÀ¸¸ç, ´Ù¸¥ »óÇ°À» ºÏÄ«Æ®¿¡ ÇÔ²² ´ãÀ¸½Ç °æ¿ì Çؿܹè¼ÛÀÌ ºÒ°¡ÇÕ´Ï´Ù.
ÇØ¿ÜÁÖ¹®¹è¼Û ¼ºñ½º´Â ÀÎÅÍÆÄÅ© µµ¼ ȸ¿ø °¡ÀÔÀ» Çϼž߸¸ ½Åû °¡´ÉÇÕ´Ï´Ù. |
|
¾Ë¾ÆµÎ¼¼¿ä!!! |
µµ¸Å»ó ¹× Á¦ÀÛ»ç »çÁ¤¿¡ µû¶ó Ç°Àý/ÀýÆÇ µîÀÇ »çÀ¯·Î Ãë¼ÒµÉ ¼ö ÀÖ½À´Ï´Ù.
¿ÀǸ¶ÄϾ÷üÀÇ ¹è¼ÛÁö¿¬½Ã ÁÖ¹®ÀÌ ÀÚµ¿À¸·Î Ãë¼ÒµÉ ¼ö ÀÖ½À´Ï´Ù.
Ãâ°í°¡´É ½Ã°£ÀÌ ¼·Î ´Ù¸¥ »óÇ°À» ÇÔ²² ÁÖ¹®ÇÒ °æ¿ì Ãâ°í°¡´É ½Ã°£ÀÌ °¡Àå ±ä ±âÁØÀ¸·Î ¹è¼ÛµË´Ï´Ù.
À¯ÅëÀÇ Æ¯¼º»ó Ãâ°í±â°£Àº ¿¹Á¤º¸´Ù ¾Õ´ç°ÜÁö°Å³ª ´ÊÃçÁú ¼ö ÀÖ½À´Ï´Ù.
Åùè»ç ¹è¼ÛÀÏÀÎ ¼¿ï ¹× ¼öµµ±ÇÀº 1~2ÀÏ, Áö¹æÀº 2~3ÀÏ, µµ¼, »ê°£, ±ººÎ´ë´Â 3ÀÏ ÀÌ»óÀÇ ½Ã°£ÀÌ ¼Ò¿äµË´Ï´Ù. |
|
|
|
|