eri-trabiccolo / lifterlms-rest

LifterLMS REST API Feature Plugin

LifterLMS REST API

A REST API feature plugin for LifterLMS.

This specification (and repository) is currently under construction. It is not yet a functional API.

Contributing

We are looking for both API specification designers and developers interested in contributing. The best way to contribute is to join us in #developers on the official LifterLMS Slack community.

Specification & Documentation

The LifterLMS REST API follows the OpenAPI Specification (Version 3.0.0).

REST API documentation is available at gocodebox.github.io/lifterlms-rest/.

The full OpenAPI spec can be downloaded in json or yaml formats.

Building & Developing REST API Doc spec

This repo uses ReDoc.

To build the docs locally for development:

• npm install in the repo root.
• npm start: Starts the development server.
• npm run build: Bundles the spec and prepares web_deploy folder with static assets.
• npm test: Validates the spec.
• npm run gh-pages: Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.