Kommunikation regiert die Welt. Interaktion ist zwischen Menschen und zwischen Software erforderlich. Möchten Sie eine angemessene Antwort auf Ihre Bewerbungsanfrage? API, um Ihnen zu helfen! Die Notwendigkeit, eine API zu implementieren, tritt in fast allen Projekten auf, und im Laufe der Zeit fragen wir uns, ob es möglich ist, die aktuelle API zu verbessern. Eine Abfolge spezifischer Schritte und realer Beispiele ist unser Rezept für die Erstellung einer funktionierenden Web-API des Projekts.
Die erste Frage lautet: "Lohnt es sich wirklich, eine neue Version der API zu implementieren?" Die Version, die bereits funktioniert, erfüllt möglicherweise alle Kriterien, die Sie benötigen. Wenn Sie die gestellte Frage jedoch bereits mit "Ja" beantwortet haben, lesen Sie weiter und finden Sie unsere Antwort. Wenn Ihre Antwort Nein lautet, lesen Sie auch weiter und wenden Sie unsere Design- und Implementierungserfahrung in Ihren nächsten Projekten an.
, 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 , . . ? !