Clever Geek Handbook

Créer une nouvelle version de l'API. Rapide et facile

La communication gouverne le monde. Une interaction est nécessaire entre les personnes et entre les logiciels. Vous souhaitez une réponse adéquate à votre demande de candidature? API pour vous aider! La nécessité de mettre en œuvre une API se pose dans presque tous les projets, et au fil du temps on se demande s'il est possible d'améliorer l'API actuelle? Une séquence d'étapes spécifiques et d'exemples réels est notre recette pour créer une API Web fonctionnelle du projet.





La première question à se poser est: "Vaut-il vraiment la peine d'implémenter une nouvelle version de l'API?" La version qui fonctionne déjà peut répondre à tous les critères dont vous avez besoin. Mais si vous avez déjà répondu «oui» à la question posée, poursuivez votre lecture et trouvez notre réponse. Si votre réponse est non, poursuivez votre lecture et appliquez notre expérience de conception et de mise en œuvre dans vos prochains projets.





, 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 .





  1. 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 , . . ? !







More articles:


All Articles