@apisyouwonthate/style-guide/__tests__/api-health-format.test.ts

Make your HTTP APIs better, faster, stronger, whether they are still being designed (API Design-First) or your organization has flopped various mismatched APIs into production and now you're thinking some consistency would be nice. Using Spectral and Open

import { DiagnosticSeverity } from "@stoplight/types";
import testRule from "./__helpers__/helper";

const template = (contentType: string) => {
  return {
    openapi: "3.1.0",
    info: { version: "1.0", contact: {} },
    paths: {
      "/health": {
        get: {
          summary: "Your health endpoint",
          responses: {
            "200": {
              description: "Error",
              content: {
                [contentType]: {},
              },
            },
          },
        },
      },
    },
  };
};

testRule("api-health-format", [
  {
    name: "valid case",
    document: template("application/health+json"),
    errors: [],
  },

  {
    name: "invalid case if plain json",
    document: template("application/json"),
    errors: [
      {
        message:
          "Health path (`/health`) SHOULD support Health Check Response Format",
        path: [
          "paths",
          "/health",
          "get",
          "responses",
          "200",
          "content",
          "application/json",
        ],
        severity: DiagnosticSeverity.Warning,
      },
    ],
  },

  {
    name: "invalid case if any other mime type",
    document: template("text/png"),
    errors: [
      {
        message:
          "Health path (`/health`) SHOULD support Health Check Response Format",
        path: [
          "paths",
          "/health",
          "get",
          "responses",
          "200",
          "content",
          "text/png",
        ],
        severity: DiagnosticSeverity.Warning,
      },
    ],
  },
]);