Skip to content
Health Check Response RFC Draft for HTTP APIs
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.githooks
.editorconfig
.gitignore
.nojekyll
CREDITS
LICENSE
Makefile
README.md
draft-inadarei-api-health-check-00.html
draft-inadarei-api-health-check-00.txt
draft-inadarei-api-health-check-00.xml
draft-inadarei-api-health-check-01.html
draft-inadarei-api-health-check-01.txt
draft-inadarei-api-health-check-01.xml
draft-inadarei-api-health-check-02.html
draft-inadarei-api-health-check-02.txt
draft-inadarei-api-health-check-02.xml
draft-inadarei-api-health-check-03.html
draft-inadarei-api-health-check-03.txt
draft-inadarei-api-health-check-03.xml
draft-inadarei-api-health-check-04.html
draft-inadarei-api-health-check-04.txt
draft-inadarei-api-health-check-04.xml
draft.md
index.html
index.txt

README.md

api-healthcheck

Health Check Response RFC Draft for HTTP APIs

Published RFC Draft: https://tools.ietf.org/html/draft-inadarei-api-health-check

Workspace Setup

> git clone https://github.com/inadarei/rfc-healthcheck.git
> sudo -H gem install kramdown-rfc2629
> sudo -H easy_install pip # optional, if you don't already have it
> sudo -H sudo pip install xml2rfc
> .githooks/install.sh # to enable automated rebuilds on git push

Using

  1. Edit draft.md

  2. To regenerate the latest version of XML/TXT/HTML;

    make latest
    

Known Implementations

  1. Node.js: https://github.com/inadarei/maikai
  2. Golang: https://github.com/nelkinda/health-go

References

In creation of this RFC following existing standards were reviewed and taken into account:

  1. Kubernetes health
  2. Azure health
  3. Spring Boot
  4. Node Terminus
You can’t perform that action at this time.