User Tools

Site Tools


api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
api [2019/03/21 09:50] – [Implementation] skipidarapi [2023/12/01 21:27] (current) skipidar
Line 5: Line 5:
 JSON API, OpenAPI and JSON Schema Working in Harmony JSON API, OpenAPI and JSON Schema Working in Harmony
 https://blog.apisyouwonthate.com/json-api-openapi-and-json-schema-working-in-harmony-ad4175f4ff84 https://blog.apisyouwonthate.com/json-api-openapi-and-json-schema-working-in-harmony-ad4175f4ff84
 +
 +
 +==== Communication options =====
 +
 +{{https://s3.eu-central-1.amazonaws.com/alf-digital-wiki-pics/sharex/rNvZHNhbje.png}}
 +
 +==== IDEA ====
 +
 +=== Graphql API ===
 +Get the data by describing it https://graphql.org/
 +
 +
 +=== HATEOAS API ===
 +Use links and self describtive API resources, to navigate trhough teh API.
 +
 +
 +
 +
 +==== Standard ====
 +
 +=== HAL - Hypermedia api langauge ===
 +
 +HAL really is just a document format for a hypermedia API, like HTML is for hypertext. It doesn’t tell you how to express your domain model, and doesn’t really tell you how to use HAL to submit changes.
 +
 +
 +=== JSON:API  ===
 +Whereas JSON API is almost like an “ORM over HTTP”, HAL does a lot less for you though, so it’s not really an apples-to-apples type of comparison.
 +
 +HAL really is just a document format for a hypermedia API, like HTML is for hypertext. It doesn’t tell you how to express your domain model, and doesn’t really tell you how to use HAL to submit changes.
  
  
Line 29: Line 58:
  
 ==== Implementation ==== ==== Implementation ====
 +
 +
  
 === Spring HATEOAS === === Spring HATEOAS ===
Line 50: Line 81:
  
  
 +=== Spring Katharsis.io ===
 +The lib, helping to implement an API, which is conform to Json:API.
 +
 +  * https://dzone.com/articles/create-a-json-api-rest-service-with-spring-boot-an
 +  * https://dzone.com/articles/json-api-using-katharsis-amp-spring-boot
 +
 +  * There are also libs, which generate a JSON:API conform API from Resources and Data Access Objects. E.g. https://dzone.com/articles/json-api-using-katharsis-amp-spring-boot
 +  * There is a detailed description of the API structure, separated from the implementation: https://jsonapi.org/ It gives me the possibility to design equally structured APIs, even when using different technologies. (Can mix up e.g. serverless implementations with e.g. Spring)
 +  * There is a JSON Schema, helping to validate our APIs automagically E.g. https://jsonapi-validator.herokuapp.com/
  
  
api.1553161825.txt.gz · Last modified: (external edit)