Category: Uncategorized
-
A JSON Schema generator understanding API design
Humans like examples People are awesome at making general conclusions based on examples. Many of us would look at the example above and see general patterns which are not just based on what is part of the actual example but heavily influenced by individual experiences. For someone who is familiar with JSON APIs of a certain…
-
Model actions (do stuff!) in REST API style
A short description for anyone on how POST, GET, PUT/PATCH and DELETE is enough to express anything you need. REST APIs only handle “things”… REST APIs are APIs for handling “things” – your business things. Example of things may be “customer” or “payments” and are always nouns. “pay” however is not a thing as it…
-
Building business APIs without coding
Building business APIs without coding How to build an API design system utilizing JSON Schema to make non-coders stay on top of development and prevent coders from re-inventing the API wheel over and over again. APIs look and behave differently… APIs come in different technologies and styles. Different companies are invested in different technologies and…
-
Bad API made me fail as secretary!
I often spend my weekends in different sport centers as a parent supporter. As someone who had the opportunity to be part of a very positive and committed team in my youth I want my kids to experience the same thing. Coaches and trainers and other people in the club who take active roles are…
-
Build a state machine API with JSON Schema
A finite state machine is a good way to model the lifecycle of a resource and good thing for any API developer to have in the tool belt. I got inspired by this article from Red Hat and I will use the same example to build a working API with CRUD Builder using JSON Schema.…
-
What is an API Design System?
I have been involved in designing and building APIs for different organisations for the last ten years or more and one thing striking me is the importance of developer efficiency. Development of new products and ideas benefit a lot when developers have the right tools to build APIs. An API design system enables us to…
-
Secure external API calls to internal systems – a declarative approach based on JSON Schema
Secure external API calls to internal systems – a declarative approach based on JSON Schema First: This post is focusing on how to achieve fine grained access control (a.k.a field level access control) based on JSON schema as a concept. To implement a fully working access control service – other functionality like authentication, roles and…
-
Good validation error messages makes API consumers happy
Good validation error messages make API consumers happy All input to an API must be validated to avoid unintended or disallowed use. Invalid input should return a status code in the 4XX range (e.g 400, 403 or 409). But this is not enough. When I as an API consumer receive 400 (Bad request) I am…
-
Build a mock API
Build a Mock API A Mock API is useful to get feedback from API consumers (e.g developers) on the API design. It may also be useful for testing when there is no test API available. Below is an example on how to create a Mock API returning {“message”: “Hello World!”} when calling GET /examples/hello-world. To…
letsbuildapis.org 