https://github.com/wmde/wikibase-rest-api-proposal

A schema proposal for the future Wikibase REST API.
https://github.com/wmde/wikibase-rest-api-proposal

Last synced: 5 days ago
JSON representation

A schema proposal for the future Wikibase REST API.

• Host: GitHub
• URL: https://github.com/wmde/wikibase-rest-api-proposal
• Owner: wmde
• License: bsd-3-clause
• Created: 2020-07-28T14:54:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-10T19:01:14.000Z (over 1 year ago)
• Last Synced: 2024-08-01T12:30:48.129Z (3 months ago)
• Language: JavaScript
• Homepage: https://wmde.github.io/wikibase-rest-api-proposal/
• Size: 2.35 MB
• Stars: 7
• Watchers: 19
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - wmde/wikibase-rest-api-proposal - A schema proposal for the future Wikibase REST API. (others)

README

        
# 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](PRINCIPLES.md). Some existing Wikibase APIs have not been included on purpose. You can read more in the [scope document](SCOPE.md).

## 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](https://nodejs.org/en/download/package-manager/) 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

```bash

npm install

```

### Start development server

```bash

npm run watch

```

### Build for deployment

```bash

npm run build

```