ScaffoldHub
  • Introduction
  • Modeling
  • Setup
    • NextJS
    • File Storage
    • Payments with Stripe
  • Debugging
  • End-to-end and Unit Tests
  • Deployment
    • Deploy to Vercel
  • Features
    • Projects
    • Preview
    • Tenants
    • Subscriptions and Payments
    • Security
    • File Storage
    • Authentication
      • Sign-in and Sign-up and Social Sign-in
      • Invitation
      • Password Reset
      • Password Change
      • Email Verification
    • Entity
      • Form
      • Filter and List
      • Export
      • Import
    • Audit Logs
    • Internationalization (I18n)
    • API Keys
    • API Documentation
  • Package.json
  • Support
  • Changelog
    • Documentation
    • Scaffolds
  • Custom Development
  • Legacy Scaffolds
  • Go to ScaffoldHub
Powered by GitBook
On this page
  1. Features

API Documentation

PreviousAPI KeysNextPackage.json

Last updated 1 year ago

The API Documentation can be found in the bottom-left menu.

It will open a SwaggerUI generated API Documentation with all the backend endpoints.

You must generate an API Key via the application for you to be able to use the endpoints.

Here's an example from the demonstrations: https://demo.scaffoldhub.io/api-docs.

Code

API Docs are generated using https://github.com/asteasolutions/zod-to-openapi.