Docs API

FonProxy Docs API reference documentation.

FonProxy API β€” Docs

Public endpoints to browse API documentation pages.


Docs

GET /docs

List all available API documentation pages. Public β€” no auth required.

Response (200):

{
  "docs": [
    {
      "slug": "api-admin",
      "name": "Admin",
      "url": "http://localhost:3100/docs/api-admin"
    },
    {
      "slug": "api-auth",
      "name": "Auth",
      "url": "http://localhost:3100/docs/api-auth"
    },
    {
      "slug": "api-health",
      "name": "Health",
      "url": "http://localhost:3100/docs/api-health"
    },
    {
      "slug": "api-keys",
      "name": "Keys",
      "url": "http://localhost:3100/docs/api-keys"
    },
    {
      "slug": "api-order",
      "name": "Order",
      "url": "http://localhost:3100/docs/api-order"
    },
    {
      "slug": "api-payment",
      "name": "Payment",
      "url": "http://localhost:3100/docs/api-payment"
    },
    {
      "slug": "api-user",
      "name": "User",
      "url": "http://localhost:3100/docs/api-user"
    }
  ]
}

GET /docs/:slug

Read a single API documentation page by slug. Public β€” no auth required.

Parameters:

ParameterTypeDescription
slugstringDoc page slug (e.g. api-auth, api-keys, api-admin)

Response (200):

{
  "slug": "api-auth",
  "content": "# FonProxy API β€” Auth\n\nBase URL: `http://localhost:3100`\n\n..."
}

The content field contains the raw Markdown source of the documentation page.

Error (404):

{ "message": "docs.not_found" }
Docs API β€” FonProxy