Make RESTful API with Go

Slide 1

Slide 1 text

Make RESTful API with Go MinJae Kwon (@mingrammer) 2017.04.15 GDG Incheon Web Seminar (without framework)

Slide 2

Slide 2 text

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

Slide 3

Slide 3 text

2. Why Go? 4. Implementation of REST API 3. API Design & Architecture Contents 5. Review & Next 1. RESTful? REST API?

Slide 4

Slide 4 text

RESTful? REST API?

Slide 5

Slide 5 text

RESTful? REST API? REpresentational State Transfer + Application Programming Interface REST API?

Slide 6

Slide 6 text

RESTful? REST API? REST API? HTTP ࢸ҅੄ ੢੼ਸ ୭؀ೠ ࢓ܽ API ইఃఫ୊ ೯ਤ Verb ಴അ Representation ੗ਗ Resource (REST API੄ 3ਃࣗ)

Slide 7

Slide 7 text

RESTful? REST API? Client API Server POST Create GET Retrieve PUT/PATCH Update DELETE Delete DB Server REST API? Simple REST Flow (Client - Server)

Slide 8

Slide 8 text

RESTful? REST API? Why REST API? Stateless Cacheable Uniform Interface Fully Client - Server Hierarchical Structure Self Descriptiveness

Slide 9

Slide 9 text

RESTful? REST API? Yes! Let’s make REST API!

Slide 10

Slide 10 text

Why Go?

Slide 11

Slide 11 text

Why Go? 1. ೧ࠁҊ रযࢲ 2. ೐ۨ੐ਕ௼о ೙ࣻח ইש 3. ղ੢ ಁః૑о ъ۱ 4. MSAী ੸೤ 5. ࠽٘ ߂ ߓನо ए਑ Because Go is AWESOME

Slide 12

Slide 12 text

Why Go? Goܳ ҕࠗೞח ੑ੢ীࢲ Go۽ API ೠ ߣ ٜ݅যࠁҊ र঻਺ ղ੢ ಁః૑о ъ۱೧ ߹ب੄ ೐ۨ੐ਕ௼ হ੉ب ѐߊ੉ оמ MSA (Micro Service Architecture)ী ੸೤ ࠽٘ ߂ ߓನо औҊ рಞ + + + + పझ౟ ಞೣ ࢿמ જ਺ ޙࢲച ಞೣ …

Slide 13

Slide 13 text

Why Go? Yes, Go is AWESOME

Slide 14

Slide 14 text

API Design & Architecture

Slide 15

Slide 15 text

API Design & Architecture Let’s make REST API for simple todo application

Slide 16

Slide 16 text

API Design & Architecture Client Auth DB Todo APIs Simple Architecture

Slide 17

Slide 17 text

API Design & Architecture Not Yet … Client Auth DB Todo APIs Simple Architecture

Slide 18

Slide 18 text

API Design & Architecture Client DB Todo APIs Public now Simple Architecture

Slide 19

Slide 19 text

API Design & Architecture Models User Project Project Project Task Task Task 1 : n 1 : n

Slide 20

Slide 20 text

API Design & Architecture Models User Project Project Project Task Task Task 1 : n 1 : n Not Yet …

Slide 21

Slide 21 text

API Design & Architecture Models Project Project Project Task Task Task 1 : n

Slide 22

Slide 22 text

API Design & Architecture Models Project Title :: string Archived :: bool Task Title :: string Priority :: enum Deadline :: datetime Done :: bool ProjectID :: int 1 : n

Slide 23

Slide 23 text

Slide 24

Slide 24 text

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

Slide 25

Slide 25 text

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

Slide 26

Slide 26 text

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

Slide 27

Slide 27 text

Implementation of REST API

Slide 28

Slide 28 text

Implementation of REST API https://github.com/mingrammer/go-todo-rest-api-example All source code is on following repository

Slide 29

Slide 29 text

Implementation of REST API ├── app │ ├── app.go │ ├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── conﬁg │ └── conﬁg.go └── main.go app/app.go Initialize the app Set all routers to app Register all handlers to app Run the app

Slide 30

Slide 30 text

Implementation of REST API app/app.go app/app.go੄ ੹୓ ҳઑ

Slide 31

Slide 31 text

Implementation of REST API app/app.go 1. ಁః૑ ࢶ঱ ߂ ೙ਃೠ ಁః૑ ੐ನ౟ github.com/gorilla/mux : ղ੢ ಁః૑ࠁ׮ ખ ؊ ಞܻೞѱ ࢎਊೡ ࣻ ੓ח Mux ۄ੉࠳۞ܻ github.com/jinzhu/gorm : Goਊ ORM ۄ੉࠳۞ܻ

Slide 32

Slide 32 text

Implementation of REST API app/app.go ۄ਋ఠ۽ github.com/gorilla/mux੄ Router ࢎਊ DB۽ github.com/jinzhu/gorm੄ DB ࢎਊ 2. ۄ਋ఠ৬ DBܳ ыחApp ҳઑ୓ ࢶ঱

Slide 33

Slide 33 text

Implementation of REST API app/app.go 3. App ୡӝചܳ ਤೠ Initialize ೣࣻ ੿੄

Slide 34

Slide 34 text

Implementation of REST API app/app.go 4. Appী ݽٚ API ۄ਋౴

Slide 35

Slide 35 text

Implementation of REST API app/app.go 5. HTTP Methodী ٮܲ ۄ਋ఠ ېಌ ೣࣻ ੿੄

Slide 36

Slide 36 text

Implementation of REST API app/app.go 6. Project API ೩ٜ۞ ഐ୹ ߂ ١۾

Slide 37

Slide 37 text

Implementation of REST API app/app.go 7. Task API ೩ٜ۞ ഐ୹ ߂ ١۾

Slide 38

Slide 38 text

Implementation of REST API app/app.go 8. HTTP࢚ীࢲ API Serverܳ ڸ਋ח Run ೣࣻ ੿੄

Slide 39

Slide 39 text

├── app │ ├── app.go │ ├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── conﬁg │ └── conﬁg.go └── main.go Implementation of REST API Provide shared functions Make response with JSON handler/common.go

Slide 40

Slide 40 text

handler/common.go੄ ੹୓ ҳઑ Implementation of REST API handler/common.go

Slide 41

Slide 41 text

Implementation of REST API handler/common.go 1. ಁః૑ ࢶ঱ ߂ ೙ਃೠ ಁః૑ ੐ನ౟

Slide 42

Slide 42 text

2. JSON ನݘਵ۽ ਽׹ਸ ࢤࢿೞח ೣࣻ ੿੄ Implementation of REST API handler/common.go

Slide 43

Slide 43 text

3. JSON ನݘਵ۽ ী۞ ਽׹ਸ ࢤࢿೞח ೣࣻ ੿੄ Implementation of REST API handler/common.go

Slide 44

Slide 44 text

├── app │ ├── app.go │ ├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── conﬁg │ └── conﬁg.go └── main.go Implementation of REST API handler/projects.go Provide handlers for Project Perform queries for Project data

Slide 45

Slide 45 text

handler/projects.go੄ ੹୓ ҳઑ Implementation of REST API handler/projects.go

Slide 46

Slide 46 text

Implementation of REST API handler/projects.go 1. ಁః૑ ࢶ঱ ߂ ೙ਃೠ ಁః૑ ੐ನ౟

Slide 47

Slide 47 text

2. /projects ೩ٜ۞ ੘ࢿ Implementation of REST API handler/projects.go GET : /projects : Get all projects POST : /projects : Create a new project

Slide 48

Slide 48 text

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

Slide 49

Slide 49 text

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

Slide 50

Slide 50 text

5. ױੌ ೐۽ં౟ܳ оઉয়ח ௪ܻ ېಌ ੘ࢿ Implementation of REST API handler/projects.go

Slide 51

Slide 51 text

├── app │ ├── app.go │ ├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── conﬁg │ └── conﬁg.go └── main.go Implementation of REST API handler/tasks.go Provide handlers for Task Perform queries for Task data

Slide 52

Slide 52 text

handler/projects.go੄ ੹୓ ҳઑ Implementation of REST API handler/tasks.go

Slide 53

Slide 53 text

Implementation of REST API 1. ಁః૑ ࢶ঱ ߂ ೙ਃೠ ಁః૑ ੐ನ౟ handler/tasks.go

Slide 54

Slide 54 text

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

Slide 55

Slide 55 text

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

Slide 56

Slide 56 text

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

Slide 57

Slide 57 text

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

Slide 58

Slide 58 text

5. ױੌ కझ௼ܳ оઉয়ח ௪ܻ ېಌ ੘ࢿ Implementation of REST API handler/tasks.go

Slide 59

Slide 59 text

├── 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

Slide 60

Slide 60 text

model/model.go੄ ੹୓ ҳઑ Implementation of REST API model/model.go

Slide 61

Slide 61 text

Implementation of REST API model/model.go 1. ಁః૑ ࢶ঱ ߂ ೙ਃೠ ಁః૑ ੐ನ౟

Slide 62

Slide 62 text

2. ప੉࠶ ݽ؛ ߂ ݽ؛ ؘ੉ఠ ઑ੘ী ೙ਃೠ ݫࢲ٘ ੿੄ Implementation of REST API model/model.go

Slide 63

Slide 63 text

3. ੿੄ೠ ݽ؛ਸ पઁ ؘ੉ఠ߬੉झী ੸ਊೞח ݃੉Ӓۨ੉࣌ ೣࣻ ੘ࢿ Implementation of REST API model/model.go ݃੉Ӓۨ੉࣌җ ೣԋ Foreign Keyܳ ࢎਊೠ Relationshipө૑ ࢤࢿ

Slide 64

Slide 64 text

├── 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

Slide 65

Slide 65 text

1. Config ҳઑ୓৬ DBConfig ҳઑ୓ ੿੄ Implementation of REST API config/config.go DBCofingܳ ࢚ਤ Config ҳઑ୓ী ੐߬٬

Slide 66

Slide 66 text

2. Predefined ࢸ੿чਸ о૓ Config ੋझఢझܳ ߈ജೞח ೣࣻ ੘ࢿ Implementation of REST API config/config.go

Slide 67

Slide 67 text

├── app │ ├── app.go │ ├── handler │ │ ├── common.go │ │ ├── projects.go │ │ └── tasks.go │ └── model │ └── model.go ├── conﬁg │ └── conﬁg.go └── main.go Implementation of REST API main.go Main for running the app

Slide 68

Slide 68 text

1. Appী Conﬁg ੋझఢझܳ ੹׳೧ ୡӝച ೠ ٍ ࢲߡ प೯ Implementation of REST API main.go

Slide 69

Slide 69 text

Implementation of REST API Then $ go build $ ./go-todo-rest-api-example

Slide 70

Slide 70 text

Implementation of REST API http://127.0.0.1:3000/projects/title/tasks/3 Test Example

Slide 71

Slide 71 text

Implementation of REST API Congraturation!! You have a REST API written in Go now!

Slide 72

Slide 72 text

Review & Next

Slide 73

Slide 73 text

Review & Next Q. ௏٘о ੉ࢂо? Go ঱য ੗୓۽݅ ࠁݶ, ঱যী ࠂ੟ೠ ѐ֛ب ݆੉ হҊ ޙߨ੉ рѾೞݴ ղ ੢ ಁః૑о ೧઱ח ੌ੉ ݆ӝ ٸޙী ੹୓੸ੋ ௏٘੄ оةࢿ੉ ڄয૑૓ ঋ ਵݴ Gofmtۄח ో୓ੋ੉ ੓য ௏٘੄ ੌҙࢿਸ ਬ૑ೡ ࣻ ੓׮ח ੢੼੉ ੓ ਺ ૒੽ ѐߊೠ ҙ੼ীࢲ ࠁ੗ݶ, যו ੿ب ੹୓੸ੋ ҳઑܳ ࢤпೞҊ ࢸ҅৬ ௏ ٘ ѐߊਸ ೮ӝ ٸޙী അ੤ ࢚క۽ח աࢁ૑ ঋ׮Ҋ ࢤпೣ.     ׮݅, Go۽ REST API ѐߊ੉ ୊਺੉ӝب ೞҊ, ೐ۨ੐ਕ௼١ਸ ࢎਊೞ૑ ঋ ওӝী ୶࢚ചա ௏٘੄ ҳઑച١਷ ই૒ ؏ ૓೯غ঻׮Ҋ ࢤпೞݴ, ৈ੹൤ ѐࢶ੄ ৈ૑ח ҔҔী ࠁ੐. Review

Slide 74

Slide 74 text

Q. ѐߊ դ੉بח যڃо? ૑ਗغח ղ੢ ಁః૑о ೂࠗೞݴ, খࢲ ঱ә೮٠੉ ঱যо рѾೞѱ ٸޙী ѐߊ ੘স ੗୓ח ҭ੢൤ ࣻਘ೮਺. դ੉بۄҊ ೠ׮ݶ, য়൤۰ ੹୓੸ੋ ࢸ҅৬ ௏٘ ҳઑച৬ ҙ۲ػ դ੉بܳ ݈ೡ ࣻ ੓חؘ, ੉ח REST API੉ա ਢѐߊ ژח ইఃఫ୛੄ ૑ध੉ա ҃೷ ী ٮۄ ׳ۄ૕ Ѫ э਺ Review & Next Review

Slide 75

Slide 75 text

Q. ೐ۨ੐ਕ௼ হ੉ ൨ٜ૑ ঋ਷о? ਗېח ઱۽ Pythonਵ۽ ਢѐߊҗ API ѐߊਸ ೧৳חؘ, Python੄ ҃਋ ࢎ प ೐ۨ੐ਕ௼ হ੉ ѐߊೞӝо ࢚׼൤ য۰਎ ࣻ ੓ਵݴ Flaskա Django١ ੄ ೐ۨ੐ਕ௼ח Ѣ੄ ೙ࣻ੐ Ӓ۞ա Goীࢲח ঱য ରਗীࢲ ઁҕೞח ղ੢ ಁః૑ੋ net/http۽ب ୽࠙ ೮਺. ౠ൤, Pythonীࢲ੄ Flaskա Djangoীࢲח ੗୓੸ਵ۽ ઁҕೞח ੜ ୶࢚ചػ ೣٜࣻਸ ࢎਊೞח ߑधҗ Goীࢲ੄ ղ੢ ಁః૑ܳ ࢎਊೞח ߑध ੉ Ѣ੄ ࠺त೮ӝ ٸޙী, ٮ۽ ೐ۨ੐ਕ௼੄ ೙ਃࢿ਷ ޅו՝ ޛۿ, ա੄ ҃਋ gorilla/mux৬ gormਸ оઉ׮ ॳӟ ೮૑݅ ੉ח ױࣽ൤ net/http੄ ખ ؊ ಞܻೠ ېಌ ӒܻҊ ORM੉ӝ ٸޙী ೙ਃೠ ҃਋ী݅ ݽ ٕ୊ۢ ॶ ࣻ ੓਺. ૊, ೙ਃೠ ࠗ࠙ী ೧׼ೞח ੘਷ ۄ੉࠳۞ܻٜਸ оઉ׮ ॳݶ غӝ ٸޙী ಽझఖ ೐ۨ੐ਕ௼ח ই૒ө૓ ೙ਃࢿਸ ޅו՝ Review & Next Review

Slide 76

Slide 76 text

Q. Ӓۧ׮ݶ Auth, Sessions ١ਸ ਤೠ ۄ੉࠳۞ܻח ݆਷о? Review & Next ղо ࢎਊ೮؍ gorilla/mux੄ gorillaۄҊ ೞח ਢోఉীب gorilla/sessionsо ੓ਵݴ, jwt-go৬ э਷ ৈ۞ ࣁ࣌੉ա ࠁউ ҙ۲ ۄ੉࠳۞ܻٜ੉ ઓ੤ೞҊ ੓਺. Go۽ ٜ݅য૓ ೐ۨ੐ਕ௼ীࢲب ੗୓੸ਵ۽ ૑ਗೞח ҃਋ب ੓ਵݴ, ೐ۨ੐ਕ௼ ܳ ॳ૑ ঋח׮Ҋ೧ب ਤ৬ э਷ Ѫٜਸ оઉ׮ ॶ ࣻ ੓਺. Goח ޷ٜਝয ׮ܖӝо ೩ٜ۞ ׮ܖחѪҗ ௼ѱ ׮ܳѱ হয য۵૑ ঋӝ ٸޙী ۄ੉࠳۞ܻ݅ оઉ৬ࢲ ਤ੄ ӝמٜਸ ҳഅೞחѱ ࣻਘೡ ࣻ ੓਺ Review

Slide 77

Slide 77 text

Review & Next Q. ҙܻ ژח ഛ੢ࢿ਷ જ਷о? ਋ࢶ Goܳ ੉޷ ॄࠌѢա ॳҊ ੓׮ח о੿ೞীࢲח, ѐੋ੸ਵ۽ח গ೒ܻா ੉࣌ ਬ૑ࠁࣻ৬ ഛ੢ࢿ਷ ݒ਋ ਋ࣻೞ׮Ҋ ࢤпೣ ௼۽झ ஹ౵ੌ੉ ૑ਗغݴ, ױੌ ߄੉ցܻ۽ ஹ౵ੌ੉ غӝ ٸޙী MSAী ҭ ੢൤ ੸೤೧ ഛ੢ࢿ੉ ҭ੢൤ જਵݴ, খࢲ ݈೮٠੉, ਢ ೐ۨ੐ਕ௼ী ؀ೠ ઙ ࣘࢿب ߹۽ হӝ ٸޙী ਗೞח ಁః૑ٜ݅ਸ оઉ׮о ݽٕ୊ۢ ॶ ࣻ ੓য ഛ੢੉ա ழझఠ݃੉૚੉ ಞܻೣ ژೠ go fmtա go test ӒܻҊ go docҗ э਷ ղ੢ ో୓ੋਸ ࢎਊೞݶ ௏ ٘ ੌҙࢿ ਬ૑, పझ౟ ӒܻҊ ޙࢲചب ݒ਋ औҊ ಞܻೞѱ ೡ ࣻ ੓਺ ಁః૑ ҙܻ੄ ҃਋ীח, ই૒ Go ౱ীࢲ ҕध੸ਵ۽ ѐߊೞҊ ੓ח ಁః૑ ݒפ੷о ߬ఋ ߡ੹੉ӝ ٸޙী ઑӘ ইए਍х੉ ੓ӟೞ૑݅ അઓೞח glide ܳ ࢎਊೡ ࣻب ੓Ҋ, റী ҕध ಁః૑ ݒפ੷ ੿ध ߡ੹੉ ܾܻૉ ػ׮ݶ ؊ ਌ ಞܻೡ Ѫਵ۽ ࠁ੐ Review

Slide 78

Slide 78 text

Review & Next ޷ҳഅػ User৬ Authܳ ୶оೞৈ ࠁউө૑ Ҋ۰ೠ पઁ۽ ࢎਊ оמೠ REST APIܳ ࢎਊೡ ࣻ ੓ب۾ ѐࢶ ߓನ੄ ਊ੉ࢿਸ ഝਊೠ ߓನ ೐۽ࣁझ ୶о ݽٚ APIী ؀ೠ ਬ׫ పझ౟௏٘ ୶о ખ ؊ RESTfulೞѱ ௏٘ܳ ੘ࢿೡ ࣻ ੓ب۾ ೞח Wrapper ѐߊ Next REST API ޙࢲച (with GoDoc) + ౚషܻ঴ ઁ੘

Slide 79

Slide 79 text

хࢎ೤פ׮ MinJae Kwon (@mingrammer) 2017.04.15 GDG Incheon Web Seminar Make RESTful API with Go