mirror of https://github.com/logto-io/logto.git synced 2024-12-23 20:33:16 -05:00

History

Gao Sun b05fb2960d chore(core): enforce summary and description for Management APIs		2023-12-03 19:10:21 +08:00
..
src	chore(core): enforce summary and description for Management APIs	2023-12-03 19:10:21 +08:00
static/html
CHANGELOG.md	release: version packages (#4873 )	2023-11-14 19:57:42 +08:00
jest.config.js
jest.setup.js
nodemon.json	chore(core): fix dev script (#4882 )	2023-11-15 14:04:41 +08:00
package.json	chore: add openapi-types to deps	2023-12-03 19:05:12 +08:00
README.md	chore: use sentence case	2023-10-25 14:01:49 +08:00
tsconfig.base.json
tsconfig.build.json
tsconfig.json
tsconfig.test.json

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.