Realización de una nueva versión de la API. Rapido y facil

La comunicación gobierna el mundo. Se necesita interacción entre personas y entre software. ¿Quiere una respuesta adecuada a su solicitud de solicitud? API para ayudarte! La necesidad de implementar una API surge en casi todos los proyectos, y con el tiempo nos preguntamos si es posible mejorar la API actual. Una secuencia de pasos específicos y ejemplos reales es nuestra receta para crear una API web funcional del proyecto.





, : « API?» , . «» , . «», .





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








All Articles