Skip to content

wmde/wikibase-rest-api-proposal

Repository files navigation

Wikibase REST API Proposal

Prototype schema for the future Wikibase REST API.

The schema can be previewed at https://wmde.github.io/wikibase-rest-api-proposal

The specification follows some general API design principles. Some existing Wikibase APIs have not been included on purpose. You can read more in the scope document.

Development

This project is using a Javascript tool chain to build an OpenAPI specification and a user interface to show it.

Prerequisites

Make sure you have Node v10 or up installed. Alternatively, all commands can be run inside of a docker container (e.g. docker run --rm -v ${PWD}:/app -w /app node:10 npm install).

All documented commands should be run from the root directory of the cloned repository.

Install Dependencies

npm install

Start development server

npm run watch

Build for deployment

npm run build