すぐ使える！入門API設計ワークショップ

” ”
HAL
WEB 4
pei0804
pei0804

API Application Programming Interface
 
 
 
 
Wikipedia

1  
 
http://www.timer-tab.com/

API  
:3  
 http://www.timer-tab.com/

WebAPI
Connpass API  
 
/events GET  
 
 
 
API

:3  

URL
Uniform Resource Locator  
 
 
Web

URL URI
• /users  
• /users/1 
ID 1

URL  
 
:2  

• /users/
• /users/1 ID 1
• ???????
• ??????? ID 1
• ??????? ID 1

• /users/
• /users/1 ID 1
• /users
• /users/1 ID 1
• /users/1 ID 1

HTTP  
:2  

GET/POST/PUT/DELETE
???? /users
???? /users/1 ID
???? /users
???? /users/1 ID 1
???? /users/1 ID 1

GET /users
GET /users/1 ID
POST /users
PUT /users/1 ID 1
DELETE /users/1 ID 1

GET /users/1 ID
POST /users
PUT /users/1 ID 1
DELETE /users/1 ID 1
GET /users

• URL
• KISS
• URL
• /self /me
• URL /v1  
•

HTTP
• 200
• 300
• 400  
• 500

:2  

:4  

GET /users (????)
GET /users/1 ID (????)
POST /users (????)
PUT /users/1 ID 1 (????)
DELETE /users/1 ID 1 (????)

GET /users (200)
GET /users/1 ID (200)
POST /users (201)
PUT /users/1 ID 1 (200 OR 204)
DELETE /users/1 ID 1 (204)

•  
GitHub  
401  
• 200 OK
• 400 500

GET /users
[
{
"id" : 1
"name": "TOM"
"email": "hogehoge@gmail.com"
},
{
"id" : 2
"name": "BOB"
"email": "foooooo@gmail.com"
},{…}
]

GET /users/1
{
"id" : 1
"name": "TOM"
"email": "hogehoge@gmail.com"
}

API  
:10  

•  
•  
status:200  
Header Header
• data  
Link RFC5988

• REST Full
• API Swagger
• GithubAPI
•
• CORS
•

すぐ使える！入門API設計ワークショップ

Recomendados