logto/packages/core/README.md

@logto/core

The core backend service.

Get started

Copy proper .env to project root. (TBD: design the config process)

pnpm i && pnpm dev

OpenAPI documentation

OpenAPI (Swagger) json is available on http(s)://your-domain/api/swagger.json. If you are running locally, the default URL will be http://localhost:3001/api/swagger.json. Consume it in the way you like.

Using ReDoc

The doc website can be served by redoc-cli in an extremely easy way:

npx redoc-cli serve http://localhost:3001/api/swagger.json

Using Swagger editor

Copy the API output and paste it in the Swagger Editor.