Share
Embed
Make RESTful API with Go
Introduce a way to create RESTful API with Go, but without framework. (프레임워크 없이 Go로 RESTful API 만드는 방법 소개)
mingrammer
April 15, 2017
Transcript
79 slides
-
Make RESTful API with Go MinJae Kwon (@mingrammer) 2017.04.15 GDG
Incheon Web Seminar (without framework) -
Name ӂ (MinJae Kwon) Nickname @mingrammer Email [email protected] Who ইҮ
ࣗਝযҗ 3֙ / Backend Developer Blog https://mingrammer.com Facebook https://facebook.com/mingrammer Github https://github.com/mingrammer Eng Blog https://medium.com/@mingrammer -
2. Why Go? 4. Implementation of REST API 3. API
Design & Architecture Contents 5. Review & Next 1. RESTful? REST API? -
RESTful? REST API? REST API? HTTP ࢸ҅ ਸ ୭ೠ ܽ
API ইఃఫ ೯ਤ Verb അ Representation ਗ Resource (REST API 3ਃࣗ) -
RESTful? REST API? Client API Server POST Create GET Retrieve
PUT/PATCH Update DELETE Delete DB Server REST API? Simple REST Flow (Client - Server) -
RESTful? REST API? Why REST API? Stateless Cacheable Uniform Interface
Fully Client - Server Hierarchical Structure Self Descriptiveness -
Why Go? 1. ೧ࠁҊ रযࢲ 2. ۨਕо ࣻח ইש 3.
ղ ಁఃо ъ۱ 4. MSAী 5. ࠽٘ ߂ ߓನо ए Because Go is AWESOME -
Why Go? Goܳ ҕࠗೞח ੑীࢲ Go۽ API ೠ ߣ ٜ݅যࠁҊ
र ղ ಁఃо ъ۱೧ ߹ب ۨਕ হب ѐߊ оמ MSA (Micro Service Architecture)ী ࠽٘ ߂ ߓನо औҊ рಞ + + + + పझ ಞೣ ࢿמ જ ޙࢲച ಞೣ … -
API Design & Architecture Let’s make REST API for simple
todo application -
API Design & Architecture Not Yet … Client Auth DB
Todo APIs Simple Architecture -
API Design & Architecture Client DB Todo APIs Public now
Simple Architecture -
API Design & Architecture Models User Project Project Project Task
Task Task 1 : n 1 : n -
API Design & Architecture Models User Project Project Project Task
Task Task 1 : n 1 : n Not Yet … -
API Design & Architecture Models Project Title :: string Archived
:: bool Task Title :: string Priority :: enum Deadline :: datetime Done :: bool ProjectID :: int 1 : n -
API Design & Architecture /projects • GET : Get all
projects • POST : Create a new project /projects/:title • GET : Get a project • PUT : Update a project • DELETE : Delete a project /projects/:title/archive • PUT : Archive a project • DELETE : Restore a project Projects API Design -
API Design & Architecture /projects/:title/tasks • GET : Get all
tasks of a project • POST : Create a new task in a project /projects/:title/tasks/:id • GET : Get a project of a project • PUT : Update a project of a project • DELETE : Delete a project of a project /projects/:title/tasks/:id/complete • PUT : Archive a project of a project • DELETE : Restore a project of a project Tasks API Design -
API Design & Architecture /projects • GET : Get all
projects • POST : Create a new project /projects/:title • GET : Get a project • PUT : Update a project • DELETE : Delete a project /projects/:title/archive • PUT : Archive a project • DELETE : Restore a project /projects/:title/tasks • GET : Get all tasks of a project • POST : Create a new task in a project /projects/:title/tasks/:id • GET : Get a project of a project • PUT : Update a project of a project • DELETE : Delete a project of a project /projects/:title/tasks/:id/complete • PUT : Archive a project of a project • DELETE : Restore a project of a project API Design -
API Design & Architecture ├── app │ ├── app.go │
├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Application Structure Our API core handlers Common response functions APIs for Project model APIs for Task model Models for our application Configuration Init, route and run the app -
Implementation of REST API ├── app │ ├── app.go │
├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go app/app.go Initialize the app Set all routers to app Register all handlers to app Run the app -
Implementation of REST API app/app.go 1. ಁః ࢶ ߂ ਃೠ
ಁః ನ github.com/gorilla/mux : ղ ಁఃࠁ ખ ؊ ಞܻೞѱ ࢎਊೡ ࣻ ח Mux ۄ࠳۞ܻ github.com/jinzhu/gorm : Goਊ ORM ۄ࠳۞ܻ -
Implementation of REST API app/app.go ۄఠ۽ github.com/gorilla/mux Router ࢎਊ DB۽
github.com/jinzhu/gorm DB ࢎਊ 2. ۄఠ৬ DBܳ ыחApp ҳઑ ࢶ -
├── app │ ├── app.go │ ├── handler │ │
├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Implementation of REST API Provide shared functions Make response with JSON handler/common.go -
2. JSON ನݘਵ۽ ਸ ࢤࢿೞח ೣࣻ Implementation of REST
API handler/common.go -
3. JSON ನݘਵ۽ ী۞ ਸ ࢤࢿೞח ೣࣻ Implementation of
REST API handler/common.go -
├── app │ ├── app.go │ ├── handler │ │
├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Implementation of REST API handler/projects.go Provide handlers for Project Perform queries for Project data -
2. /projects ೩ٜ۞ ࢿ Implementation of REST API handler/projects.go GET
: /projects : Get all projects POST : /projects : Create a new project -
3. /projects/:title ೩ٜ۞ ࢿ Implementation of REST API handler/projects.go GET
: /projects/:title : Get a project PUT : /projects/:title : Update a project DELETE : /projects/:title : Delete a project -
4. /projects/:title/archive ೩ٜ۞ ࢿ Implementation of REST API handler/projects.go PUT
: /projects/:title/archive : Archive a project DELETE : /projects/:title/archive : Restore a project -
5. ױੌ ۽ંܳ оઉয়ח ௪ܻ ېಌ ࢿ Implementation of REST
API handler/projects.go -
├── app │ ├── app.go │ ├── handler │ │
├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Implementation of REST API handler/tasks.go Provide handlers for Task Perform queries for Task data -
Implementation of REST API 1. ಁః ࢶ ߂ ਃೠ ಁః
ನ handler/tasks.go -
2. /projects/:title/tasks ೩ٜ۞ ࢿ Implementation of REST API GET :
/projects/:title/tasks: Get all tasks of a project POST : /projects/:title/tasks: Create a new task in a project handler/tasks.go -
3. /projects/:title/tasks/:id ೩ٜ۞ ࢿ Implementation of REST API GET :
/projects/:title/tasks/:id : Get a task of a project PUT : /projects/:title/tasks/:id: Update a task of a project DELETE : /projects/:title/tasks/:id : Delete a task of a project handler/tasks.go -
3. /projects/:title/tasks/:id ೩ٜ۞ ࢿ (continue) Implementation of REST API GET
: /projects/:title/tasks/:id : Get a task of a project PUT : /projects/:title/tasks/:id: Update a task of a project DELETE : /projects/:title/tasks/:id : Delete a task of a project handler/tasks.go -
4. /projects/:title/tasks/:id/complete ೩ٜ۞ ࢿ Implementation of REST API PUT :
/projects/:title/tasks/:id/complete : Complete a task of a project DELETE : /projects/:title/tasks/:id/complete : Undo a task of a project handler/tasks.go -
5. ױੌ కझܳ оઉয়ח ௪ܻ ېಌ ࢿ Implementation of REST
API handler/tasks.go -
├── app │ ├── app.go │ ├── handler │ │
├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Implementation of REST API model/model.go Define the model structs with Gorm Provide some methods of models Provide a DB migration function -
2. ప࠶ ݽ؛ ߂ ݽ؛ ؘఠ ઑী ਃೠ ݫࢲ٘
Implementation of REST API model/model.go -
3. ೠ ݽ؛ਸ पઁ ؘఠ߬झী ਊೞח ݃Ӓۨ࣌ ೣࣻ ࢿ Implementation
of REST API model/model.go ݃Ӓۨ࣌җ ೣԋ Foreign Keyܳ ࢎਊೠ Relationshipө ࢤࢿ -
├── app │ ├── app.go │ ├── handler │ │
├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Implementation of REST API config/config.go Provide a struct for configuration Config values is predefined -
1. Config ҳઑ৬ DBConfig ҳઑ Implementation of REST API
config/config.go DBCofingܳ ࢚ਤ Config ҳઑী ߬٬ -
2. Predefined ࢸчਸ о Config ੋझఢझܳ ߈ജೞח ೣࣻ ࢿ Implementation
of REST API config/config.go -
├── app │ ├── app.go │ ├── handler │ │
├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── config │ └── config.go └── main.go Implementation of REST API main.go Main for running the app -
1. Appী Config ੋझఢझܳ ׳೧ ୡӝച ೠ ٍ ࢲߡ प೯
Implementation of REST API main.go -
Implementation of REST API Congraturation!! You have a REST API
written in Go now! -
Review & Next Q. ٘о ࢂо? Go য ۽݅ ࠁݶ,
যী ࠂೠ ѐ֛ب ݆ হҊ ޙߨ рѾೞݴ ղ ಁఃо ೧ח ੌ ݆ӝ ٸޙী ੋ ٘ оةࢿ ڄয ঋ ਵݴ Gofmtۄח ోੋ য ٘ ੌҙࢿਸ ਬೡ ࣻ ח ѐߊೠ ҙীࢲ ࠁݶ, যו ب ੋ ҳઑܳ ࢤпೞҊ ࢸ҅৬ ٘ ѐߊਸ ೮ӝ ٸޙী അ ࢚క۽ח աࢁ ঋҊ ࢤпೣ. ݅, Go۽ REST API ѐߊ ӝب ೞҊ, ۨਕ١ਸ ࢎਊೞ ঋ ওӝী ୶࢚ചա ٘ ҳઑച١ ই ؏ ೯غҊ ࢤпೞݴ, ৈ ѐࢶ ৈח ҔҔী ࠁ. Review -
Q. ѐߊ դبח যڃо? ਗغח ղ ಁఃо ೂࠗೞݴ, খࢲ ә೮٠
যо рѾೞѱ ٸޙী ѐߊ স ח ҭ ࣻਘ೮. դبۄҊ ೠݶ, য়۰ ੋ ࢸ҅৬ ٘ ҳઑച৬ ҙ۲ػ դبܳ ݈ೡ ࣻ חؘ, ח REST APIա ਢѐߊ ژח ইఃఫ धա ҃ ী ٮۄ ׳ۄ Ѫ э Review & Next Review -
Q. ۨਕ হ ൨ٜ ঋо? ਗېח ۽ Pythonਵ۽ ਢѐߊҗ API
ѐߊਸ ೧৳חؘ, Python ҃ ࢎ प ۨਕ হ ѐߊೞӝо ࢚ য۰ ࣻ ਵݴ Flaskա Django١ ۨਕח Ѣ ࣻ Ӓ۞ա Goীࢲח য ରਗীࢲ ઁҕೞח ղ ಁఃੋ net/http۽ب ࠙ ೮. ౠ, Pythonীࢲ Flaskա Djangoীࢲח ਵ۽ ઁҕೞח ੜ ୶࢚ചػ ೣٜࣻਸ ࢎਊೞח ߑधҗ Goীࢲ ղ ಁఃܳ ࢎਊೞח ߑध Ѣ ࠺त೮ӝ ٸޙী, ٮ۽ ۨਕ ਃࢿ ޅו՝ ޛۿ, ա ҃ gorilla/mux৬ gormਸ оઉ ॳӟ ೮݅ ח ױࣽ net/http ખ ؊ ಞܻೠ ېಌ ӒܻҊ ORMӝ ٸޙী ਃೠ ҃ী݅ ݽ ٕۢ ॶ ࣻ . , ਃೠ ࠗ࠙ী ೧ೞח ۄ࠳۞ܻٜਸ оઉ ॳݶ غӝ ٸޙী ಽझఖ ۨਕח ইө ਃࢿਸ ޅו՝ Review & Next Review -
Q. Ӓۧݶ Auth, Sessions ١ਸ ਤೠ ۄ࠳۞ܻח ݆о? Review &
Next ղо ࢎਊ೮؍ gorilla/mux gorillaۄҊ ೞח ਢోఉীب gorilla/sessionsо ਵݴ, jwt-go৬ э ৈ۞ ࣁ࣌ա ࠁউ ҙ۲ ۄ࠳۞ܻٜ ઓೞҊ . Go۽ ٜ݅য ۨਕীࢲب ਵ۽ ਗೞח ҃ب ਵݴ, ۨਕ ܳ ॳ ঋחҊ೧ب ਤ৬ э Ѫٜਸ оઉ ॶ ࣻ . Goח ٜਝয ܖӝо ೩ٜ۞ ܖחѪҗ ѱ ܳѱ হয য۵ ঋӝ ٸޙী ۄ࠳۞ܻ݅ оઉ৬ࢲ ਤ ӝמٜਸ ҳഅೞחѱ ࣻਘೡ ࣻ Review -
Review & Next Q. ҙܻ ژח ഛࢿ જо? ࢶ Goܳ
ॄࠌѢա ॳҊ ח оೞীࢲח, ѐੋਵ۽ח গܻா ࣌ ਬࠁࣻ৬ ഛࢿ ݒ ࣻೞҊ ࢤпೣ ۽झ ஹੌ ਗغݴ, ױੌ ߄ցܻ۽ ஹੌ غӝ ٸޙী MSAী ҭ ೧ ഛࢿ ҭ જਵݴ, খࢲ ݈೮٠, ਢ ۨਕী ೠ ઙ ࣘࢿب ߹۽ হӝ ٸޙী ਗೞח ಁఃٜ݅ਸ оઉо ݽٕۢ ॶ ࣻ য ഛա ழझఠ݃ ಞܻೣ ژೠ go fmtա go test ӒܻҊ go docҗ э ղ ోੋਸ ࢎਊೞݶ ٘ ੌҙࢿ ਬ, పझ ӒܻҊ ޙࢲചب ݒ औҊ ಞܻೞѱ ೡ ࣻ ಁః ҙܻ ҃ীח, ই Go ীࢲ ҕधਵ۽ ѐߊೞҊ ח ಁః ݒפо ߬ఋ ߡӝ ٸޙী ઑӘ ইएх ӟೞ݅ അઓೞח glide ܳ ࢎਊೡ ࣻب Ҋ, റী ҕध ಁః ݒפ ध ߡ ܾܻૉ ػݶ ؊ ಞܻೡ Ѫਵ۽ ࠁ Review -
Review & Next ҳഅػ User৬ Authܳ ୶оೞৈ ࠁউө Ҋ۰ೠ पઁ۽
ࢎਊ оמೠ REST APIܳ ࢎਊೡ ࣻ ب۾ ѐࢶ ߓನ ਊࢿਸ ഝਊೠ ߓನ ۽ࣁझ ୶о ݽٚ APIী ೠ ਬ పझ٘ ୶о ખ ؊ RESTfulೞѱ ٘ܳ ࢿೡ ࣻ ب۾ ೞח Wrapper ѐߊ Next REST API ޙࢲച (with GoDoc) + ౚషܻ ઁ -
хࢎפ MinJae Kwon (@mingrammer) 2017.04.15 GDG Incheon Web Seminar Make
RESTful API with Go