Skip to content

Hackzzila/api-badge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

api-badge

API Status Build Status

Simple API status badges.

To get colors, we record min and max response times, and find where yours sits in the range, and do some math (courtesy of @appellation) to figure out a color.

Usage

Firstly you need a route on your API that returns a successful status code (2xx or 3xx) and preferably does no logic. Then you can put the badge on your README.

[![API Status](https://api-badge.hackzzila.com/v1?url=YOUR_PING_URL)](https://github.com/Hackzzila/api-badge)

About

GitHub badges for your API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published