https://github.com/sanjacob/tiny-api-client-ts
The short and sweet way to create API clients in JavaScript and TypeScript
https://github.com/sanjacob/tiny-api-client-ts
api-client decorators fetch
Last synced: 2 months ago
JSON representation
The short and sweet way to create API clients in JavaScript and TypeScript
- Host: GitHub
- URL: https://github.com/sanjacob/tiny-api-client-ts
- Owner: sanjacob
- License: lgpl-2.1
- Created: 2024-02-26T15:49:52.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-29T13:15:46.000Z (about 1 year ago)
- Last Synced: 2025-02-12T20:26:11.005Z (3 months ago)
- Topics: api-client, decorators, fetch
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/tiny-api-client
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Tiny API Client for TypeScript 🐝
[![NPM Registry][version-shield]][npm] [![License: GPL v2][license-shield]][gnu]
> [!WARNING]
> This package is in early development,
> and its API is still changing quite often.
> Use in production at your own risk.
> On the other hand, contributions are more than welcome.
The short and sweet way to write API consumers
```typescript
import { APIClient, get, post, del } from 'tiny-api-client';
@APIClient(({v}) => `https://example.org/api/public/v${v}`)
class MyAPIClient {
@get(({userId}) => `/users/${userId}`)
findUser(params: {userId: string}, options: any = {}, response?: User) {
return response;
}
@post(() => '/notes')
createNote(params: {}, options: any, response?: Note) {
return response;
}
@del(({noteId, fileId}) => `/notes/${noteId}/files/${fileId}`)
deleteNoteFile(params: {noteId: string, fileId: string}, options: any, response?: boolean) {
return response;
}
}
>> const client = new MyClient()
>> client.findUser({userId: 'PeterParker'})
{'name': 'Peter', 'surname': 'Parker', ...}
>> client.createNote({}, {body: {title: 'New Note', content: 'Hello World!'}})
{'id': ...}
```
## About
This package is my TypeScript adaptation of the tiny-api-client library I
originally wrote for Python. Its purpose is to provide an easy way for API
consumers, such as Vue or React frontends, to call operations on the API.
Note that there are significant differences between the Python and TS
interfaces. Furthermore, some of the features that exist in the Python
library do not exist in this one yet. Some features may present bugs.
### Requirements
If you are using Node.js:
- Node.js >=18.x (requires Fetch API)
## Features
- Endpoints can be declared with one of: `@get`, `@post`, `@put`, `@patch`, `@del`
- Auto-conversion of responses to *JSON*, can be disabled per endpoint
- Route parameters are optional
- Set the `.apiToken` property to send a bearer token
- Easy integration with your custom API models
- Full control over route parameter templates
- Support for API version insertion in url template
- Freedom over parameter types and defaults in each endpoint
- Wraps the native `fetch` api, and options are passed to it
## Installation
```bash
bun add tiny-api-client
```
> Feel free to use npm, yarn, or other instead
## Documentation
The documentation is still not available.
## License
[![License: LGPL v2.1][license-shield]][gnu]
This software is distributed under the
[Lesser General Public License v2.1][license],
more information available at the [Free Software Foundation][gnu].
[npm]: https://www.npmjs.com/package/tiny-api-client
[version-shield]: https://img.shields.io/npm/v/tiny-api-client?color=blue
[license]: LICENSE "Lesser General Public License v2.1"
[gnu]: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html "Free Software Foundation"
[license-shield]: https://img.shields.io/github/license/sanjacob/tiny-api-client-ts