Skip to content

Axios client built with OpenAPI generator for Raindrop.io ☔

License

Notifications You must be signed in to change notification settings

lasuillard/raindrop-client

Repository files navigation

raindrop-client

License: MIT CI codecov NPM Version

Axios client built with OpenAPI generator for Raindrop.io ☔

✨ Features

Primary features and goals are:

  • Provide unofficial OpenAPI schema for Raindrop.io
  • Fill the gap between official documentation and reality(response) with schema testing
  • Generated client package for Axios with extra functionalities

🚀 Installation

If you wish to use client package, install it:

$ npm install @lasuillard/raindrop-client

🛠️ Generate your own client

You can use OpenAPI schema in this repository to generate your own client. Following is example using openapitools/openapi-generator-cli:

$ yarn global add @openapitools/openapi-generator-cli
$ openapi-generator-cli generate -i https://raw.githubusercontent.com/lasuillard/raindrop-client/main/openapi.yaml -g typescript-axios --skip-validate-spec -o ./out

You may need Java installed as openapi-generator-cli uses it.

💖 Contributing

Dev Containers configured and ready to use. Detailed installation steps and requirements will not be described here.

📜 License

This project is licensed under the terms of the MIT license.