https://github.com/lasuillard/raindrop-client

Axios client built with OpenAPI generator for Raindrop.io ☔
https://github.com/lasuillard/raindrop-client

axios openapi openapi-generator raindrop-io typescirpt

Last synced: 19 days ago
JSON representation

Axios client built with OpenAPI generator for Raindrop.io ☔

• Host: GitHub
• URL: https://github.com/lasuillard/raindrop-client
• Owner: lasuillard
• License: mit
• Created: 2023-10-14T05:00:49.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-01T13:40:52.000Z (about 2 months ago)
• Last Synced: 2024-10-11T12:45:43.809Z (about 1 month ago)
• Topics: axios, openapi, openapi-generator, raindrop-io, typescirpt
• Language: TypeScript
• Homepage: https://lasuillard.github.io/raindrop-client/
• Size: 717 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# raindrop-client

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![CI](https://github.com/lasuillard/raindrop-client/actions/workflows/ci.yaml/badge.svg)](https://github.com/lasuillard/raindrop-client/actions/workflows/ci.yaml)

[![codecov](https://codecov.io/gh/lasuillard/raindrop-client/graph/badge.svg?token=bPq2geqXLe)](https://codecov.io/gh/lasuillard/raindrop-client)

[![NPM Version](https://img.shields.io/npm/v/%40lasuillard%2Fraindrop-client)](https://www.npmjs.com/package/@lasuillard/raindrop-client)

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:

```bash

$ 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](https://www.npmjs.com/package/@openapitools/openapi-generator-cli):

```bash

$ 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.