https://github.com/jakobw/wb-rest-api-client-demo

This repo demonstrates how to generate and use a TypeScript API client based on the Wikibase REST API's OpenAPI document.
https://github.com/jakobw/wb-rest-api-client-demo

api-client wikibase wikidata

Last synced: 5 days ago
JSON representation

This repo demonstrates how to generate and use a TypeScript API client based on the Wikibase REST API's OpenAPI document.

• Host: GitHub
• URL: https://github.com/jakobw/wb-rest-api-client-demo
• Owner: jakobw
• License: bsd-3-clause
• Created: 2023-08-30T14:36:45.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-03T12:23:09.000Z (about 1 year ago)
• Last Synced: 2024-10-10T18:53:57.882Z (26 days ago)
• Topics: api-client, wikibase, wikidata
• Language: TypeScript
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wikibase REST API client demo

This repo demonstrates how to generate and use a TypeScript API client based on [the Wikibase REST API's OpenAPI document](https://doc.wikimedia.org/Wikibase/master/js/rest-api/). The automatically generated API client features well-named methods, as well as parameter and return type hints. Here is an example:

```typescript

const itemId = 'Q11';

// get a label

labelsApi.getItemLabel( itemId, 'en' ).then( ( response ) => {

    console.log( `the label of "${itemId}" is "${response.body}"` );

} );

// replace a label

labelsApi.replaceItemLabel( itemId, 'en', { label: 'hello API' } );

// get all statements of this item

statementsApi.getItemStatements( itemId )

    .then( response => console.log( response.body ) );

// get all statements of this item that use P31 as the property

statementsApi.getItemStatements( itemId, 'P31' )

    .then( response => console.log( response.body ) );

```

## Installation

### With docker

* install dependencies: `docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app --user $(id -u):$(id -g) node:20 npm i`

* download and save the WB REST API OpenAPI document as `openapi.json` in this directory: `curl -O https://doc.wikimedia.org/Wikibase/master/js/rest-api/openapi.json`

* to generate the client run the following two commands:

  * `docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app --user $(id -u):$(id -g) node:20 npx json-dereference-cli json-dereference -s openapi.json -o openapi-dereferenced.json`

  * ```

    docker run --rm \

      --user $(id -u):$(id -g) \

      -v $PWD:/local openapitools/openapi-generator-cli generate \

      -i /local/openapi-dereferenced.json \

      -g typescript-node \

      -o /local/api-client

    ```

* you can now run the example: `docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app node:20 npm run hello-api`

### Without docker

This requires Node.js (version >= 16) and Java (version >= 11) to be installed.

* install dependencies: `npm i`

* download and save the WB REST API OpenAPI document as `openapi.json` in this directory: `curl -O https://doc.wikimedia.org/Wikibase/master/js/rest-api/openapi.json`

* to generate the client run the following two commands:

  * `npx json-dereference-cli json-dereference -s openapi.json -o openapi-dereferenced.json`

  * `npx @openapitools/openapi-generator-cli generate -i openapi-dereferenced.json -g typescript-node -o api-client`

* you can now run the example: `npm run hello-api`