image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
DocsConventionsReferencesCheatsheet
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Docker
• Kubernetes
Next
Authorization

API Documentation

Akan can render signal documentation from the generated fetch object. It is not just a static list: developers can inspect arguments, guards, REST calls, and realtime endpoints.
  • Use `Signal.Doc.Zone` for one signal namespace.
  • Use `Doc.Setting` to choose BaseURL, role, and JWT.
  • REST and WebSocket test surfaces are shown together.

Render A Zone

Place the documentation UI inside an admin or developer-only page. The `base` signal is a good first target because it has simple ping endpoints.
Developer API page

Try An Endpoint

Open the `base` document, find `ping`, and run it from the REST panel. It should return a simple string response.
GET
/ping (Ping)
Description
- Ping test endpoint
Response Type
Returns:
String!
Response Example

Auth And Roles

For guarded endpoints, open the auth modal and paste a JWT. The decoded account helps you confirm which roles are being used for the test.
  • BaseURL tells you which server the document is calling.
  • Role filters help you focus on public, user, or admin endpoints.
  • JWT is only for developer testing in this UI.

Tips

  • Expose API docs only to developers or admins.
  • Start with `base` or a small module before documenting a large domain.
  • Use the docs UI for quick manual checks, not as a replacement for automated tests.
API Documentation
Render A Zone
Try An Endpoint
Auth And Roles
Tips