api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
api [2019/03/21 09:50] – [Implementation] skipidar | api [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:// | https:// | ||
+ | |||
+ | |||
+ | ==== Communication options ===== | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | ==== IDEA ==== | ||
+ | |||
+ | === Graphql API === | ||
+ | Get the data by describing it https:// | ||
+ | |||
+ | |||
+ | === 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: | ||
+ | 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:// | ||
+ | * https:// | ||
+ | |||
+ | * There are also libs, which generate a JSON:API conform API from Resources and Data Access Objects. E.g. https:// | ||
+ | * There is a detailed description of the API structure, separated from the implementation: | ||
+ | * There is a JSON Schema, helping to validate our APIs automagically E.g. https:// | ||
api.1553161825.txt.gz · Last modified: (external edit)