API Design Guide

This is the home of the API Design Guide published by Stafrænt Ísland as a best practice guide for API development. It should help synchronize the work between developers and make working together easier. The guide covers the relevant design principles and patterns to use so the consumer experience is enjoyable and consistent throughout APIs.

This guide is under constant review and updates will be made over time as new design patterns and styles are adopted.

All feedback is welcomed and encouraged to help make the guide better so please feel free to create pull requests.

Content

• Once-Only

• Resource Oriented Design

  • Design flow

  • Resource

• Naming Conventions

  • General

  • Resources

  • Fields

• GraphQL Naming Conventions

  • Case styles

  • Input objects naming conventions

  • Query naming conventions

  • Mutation naming conventions

  • Integrating naming conventions into shared api

• Data Definitions

  • Text encoding

  • JSON

  • National identifier

  • Language and currency

  • Date and time

  • Timestamp data

• Data transfer objects

• Pagination

  • PageInfo

  • Pagination Query parameters

  • Monorepo library

• Methods

  • Methods mapping to HTTP verbs

  • Custom methods (RPC)

• REST Request

  • Query parameters

  • Path parameters

• REST Response

  • General

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

• Errors

  • Response Body

• Documentation

  • Describe error handling

  • Provide feedback mechanism

  • Example

  • Setup example

• Versioning

  • Version changes

  • URLs

  • Increment version numbers

  • Deprecating API versions

• Security

• Environments

  • Development

  • Test

  • Sandbox

  • Production

• Example Service

Changelog

Draft 4 - Published 2023-06-07

• Updated usage of HTTP status codes to use 204 instead of 404 when resources are not found or not accessible to the user.

• Update REST Requests to describe arrays in query parameters and how to handle sensitive data in query and path parameters.

• Update Custom Methods (RPC) to use verbs instead of nouns for method names with POST.

Draft 3 - Published 2022-08-16

• Improving Documentation.

• Adding description of Content Types in REST Response.

• Making hasPreviousPage and startCursor optional in Pagination.

• Adding OWASP and IAS reference in Security.

• Other small fixes.

Draft 2 - Published 2021-10-19

• Changing pagination description

Draft 1 - Published 2020-08-31

• Initial relase