Skip to content

getlago/lago-openapi

Repository files navigation

Lago OpenAPI

Open API specification for Lago project

License: AGPLv3

Current Releases

Project Release Badge
Lago Lago Release
Lago OpenAPI Lago OpenAPI Release

Usage

This repository is used to serve http://swagger.getlago.com/

Documentation

The Lago documentation is available at doc.getlago.com.

Contributing

The contribution documentation is available here

License

Lago is distributed under the AGPLv3 License.

Read more here.

Local development

Install dependencies

npm install

You may also need Docker to run some commands.

Build openapi.yaml

npm run build

Lint

npm run test

Preview using Redoc

To preview the OpenAPI specification using Redoc, you can use the following command:

npm run preview:redocly

This will watch for changes in the OpenAPI specification files and automatically rebuild and reload them.

The Redoc documentation will be available at http://localhost:8080/.

Preview using Swagger UI

To preview the OpenAPI specification using Swagger UI, as on https://swagger.getlago.com, you can use the following command:

npm run preview:swagger

The Swagger UI will be available at http://localhost:8080/.

About

Open API specification for Lago project

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 25