ApiStatusSchemaPulse / report

ApiStatusSchemaPulse report: https://api.demo.example/openapi.json

Demo report on a fictional sample site.

Try a live example in 1 click:

53 / 100

5 of 9 checks need attention (0 high priority).

  • ✓ Spec readable, OpenAPI 3.x (high): Version 3.0.3: Demo API 1.4.0; 42 paths, 77 operations.
  • ✓ Servers listed over HTTPS (high): https://api.demo.example/v1
  • ✗ operationId on 90%+ of operations (medium): 61%
  • ✗ Summaries or descriptions on 90%+ (medium): 88%
  • ✗ Error responses (4xx/5xx) documented on 80%+ (medium): 35% (success responses 100%)
  • ✗ Examples on 50%+ of operations (low): 12%
  • ✓ Auth scheme defined (medium): bearerAuth
  • ✓ Server responds in under 1 second (low): https://api.demo.example/v1: HTTP 401 in 340 ms
  • ✗ CORS header present (browser clients) (low): Not present on the base URL (fine for server-to-server APIs).

Markdown version

Fix it in minutes

Get copy-paste fixes for every failing check.

See options

Read-only: one request for the spec and one GET to the first server URL. We never call authenticated or mutating endpoints. JSON specs only for now (YAML is detected but not scored).

Often used together