Developer Portal

Nolxy auto-generates a public developer portal for your API consumers. Share your API documentation, let developers generate their own API keys, and explore available endpoints — all without writing a single line of documentation code.

Portal Overview

Each Nolxy user gets a unique portal URL based on their user hash. The portal is publicly accessible and shows:

API Information

Your API name, description, base URL, and authentication method are displayed prominently.

Route Listing

All active routes with their methods, paths, and descriptions are listed for developers to explore.

OpenAPI Spec

An auto-generated OpenAPI 3.0 specification is available for download. Includes request/response schemas from your validation config.

Accessing the Portal

Your portal URL follows this pattern:

Portal URL

https://your-nolxy-domain.com/portal/<user-hash>

# Example:
https://api.nolxy.com/portal/a1b2c3d4e5f6

Find your portal URL in the dashboard under Settings → General. Share it with your API consumers.

Self-Serve API Keys

Developers can generate their own API keys directly from the portal — no manual provisioning needed.

Generation

Developers provide a name and receive a new API key. The key is shown once and must be copied immediately.

Limits

Portal-generated keys count toward your plan's API key quota.

Management

Portal-generated keys appear in your dashboard and can be revoked, rate-limited, or scoped like any other key.

OpenAPI Specification

The portal includes a downloadable OpenAPI 3.0 spec that is auto-generated from your route and validation configurations.

Auto-generated

Routes, methods, path parameters, request schemas (from validations), and response schemas are all included automatically.

Customizable

Add descriptions and response schemas per route in Routes → API Docs tab. These appear in the generated spec.

Compatible

Import the spec into Swagger UI, Postman, Insomnia, or any OpenAPI-compatible tool for interactive documentation.

API Endpoint

GET /api/v1/portal/<user-hash>/openapi
// Returns: OpenAPI 3.0 JSON spec

Plan Requirements

Developer Portal is available on Pro plans and above.