Skip to content

ksgy/api-checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

API Checker plugin for Sublime Text

A plugin to check if an API or a site is up and running. You can make HTTP calls similar as in SublimeHttpRequester

Inspiration came from sublimetext-LondonUnderground :)

API Checker

Example configuration: (api-checker.sublime-settings)

{
	"debug": true,
	"timeout": 30,
	"up_label": "✓",
	"dn_label": "✕",
	"detailed_error": true,
	"urls": [
		{
			"title": "google",
			"request_type": "GET",
			"request_body": [
			],
			"url": "http://google.com",
		},
		{
			"title": "non-existent",
			"request_type": "POST",
			"request_body": [
				"Access-Control-Request-Headers: accept",
				"Access-Control-Allow-Origin: *",
				"Content-type: application/x-www-form-urlencoded",

				"POST_BODY:",
				"api_key=test_key&getuser=john"
			],
			"url": "http://some.non-existent.url",
		}
	]
}

Avaliable options

  • debug

    Show/hide debug messages. Prints out all request and response messages to console.

  • timeout

    How often to make request to URLs (in seconds)

  • up_label

    Label to show if the API/site is up and running

  • dn_label

    Label to show if the API/site is down

  • detailed_error

    Show/hide HTTP error code if site is down (eg.: My API✕ (500))

  • urls

    Dictionary of APIs/sites to check

    • title

      Title to show in status bar

    • request_type

      HTTP request type: POST/GET/PUT/DELETE

    • request_body

      Request headers, POST_BODY.

      See SublimeHttpRequester for more information

    • url

      URL to request

License

The MIT License (MIT)

Copyright (c) 2014 ksgy

About

Checks any API status and shows in Sublime Text Editor status bar

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •