Komunikasi menguasai dunia. Interaksi dibutuhkan antara orang-orang dan antar perangkat lunak. Apakah Anda menginginkan tanggapan yang memadai atas permintaan aplikasi Anda? API untuk membantu Anda! Kebutuhan untuk mengimplementasikan API muncul di hampir semua proyek, dan seiring waktu kami bertanya-tanya apakah mungkin untuk meningkatkan API saat ini? Urutan langkah-langkah spesifik dan contoh nyata adalah resep kami untuk membuat API web yang berfungsi dari proyek tersebut.
Pertanyaan pertama yang harus ditanyakan adalah: "Apakah benar-benar layak menerapkan versi baru API?" Versi yang sudah berfungsi mungkin memenuhi semua kriteria yang Anda butuhkan. Tetapi jika Anda telah menjawab "ya" untuk pertanyaan yang diajukan, baca terus dan temukan jawaban kami. Jika jawaban Anda tidak, baca terus dan terapkan pengalaman desain dan implementasi kami di proyek Anda berikutnya.
, API. , , , , ฬ , API, API, API. .
, API . API, , , . !
API , .
, API
, API , :
API;
, API ;
API.
, , ยซ ยป ยซ ยป.
API
, API:
0: URI HTTP ( POST);
1: URI HTTP ;
2: URI, ฬ HTTP ;
3: HATEOAS. .
API 0 1 , , :
URI, ;
, , HTTP ;
URI ฬ API;
URI ;
- URI, .
, ยซยป , . .
, API
. API, API. , .
, , . , , .
3 API . :
URI (Uniform Resource Identifier);
;
, Accept Header/Media Type.
. API .
URI , . :
URI, URI;
URI, ;
HTTP ฬ;
URI, - ฬ ;
.
:
GET v1/cats/{name}
2. , HTTP โ . URI.
:
GET cats/{name}?version=v1
3. Accept Header/Media Type , URI. :
, ;
, Postman, , ฬ HTTP .
:
GET cats/{name}
Headers: version=v1
, . , .
API
, . API backend, frontend . , , Swagger ( RESTful API), , Swagger UI:
, API. API :
0 ( URI HTTP );
, API ;
API, API ;
, API.
, , , API.
:
POST /cats - ( ,
requestBody: { );
"name": "Pushok"
}
POST /cats - ;
requestBody: {
"color": "white"
}
API
API, . , API :
ฬ ;
API;
API;
API API.
, , , , .
API
2 API. , , API.
, API 0 2 :
1. API ;
2. , : GET, POST, PUT, DELETE;
3. ;
:
GET /cats -
GET /cats/Pushok -
(, )
4. .
:
GET /cats?color=white -
API . . โ โ, . โ2.nโ.
:
, enum:
, Spring Framework Converter<S,T>. S T, Enum ApiVersion :
โ2.0โ, โv2โ. , , , enum. :
API ฬ, ฬ enum. ฬ ฬ , .
.
. -. API Swagger. , , , API.
. :
API , , . Swagger .
Swagger UI API:
:
API
0 API 2 , :
API, , ;
, API;
, .
, API , , , . .
API , . . ? !