Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strapi/strapi-sdk-javascript
🔌 Official JavaScript SDK for APIs built with Strapi.
https://github.com/strapi/strapi-sdk-javascript
api cms dashboard es6 graphql headless-cms javascript koa koa2 nodejs rest-api sdk strapi
Last synced: about 1 month ago
JSON representation
🔌 Official JavaScript SDK for APIs built with Strapi.
- Host: GitHub
- URL: https://github.com/strapi/strapi-sdk-javascript
- Owner: strapi
- License: mit
- Archived: true
- Created: 2018-03-29T09:06:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-01T07:37:36.000Z (about 2 years ago)
- Last Synced: 2024-04-29T03:45:50.257Z (4 months ago)
- Topics: api, cms, dashboard, es6, graphql, headless-cms, javascript, koa, koa2, nodejs, rest-api, sdk, strapi
- Language: TypeScript
- Homepage: https://strapi.io
- Size: 808 KB
- Stars: 270
- Watchers: 21
- Forks: 45
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-strapi - Javascript SDK - Official Javascript SDK (Currently outdated). (Strapi v3 / Plugin & Providers - v3)
README
⚠️ This package not up to date and maintained ⚠️
We recommend you not to use this package. We stopped to maintained it by lack of time and also because the features provided by this SDK are the same as a good HTTP client well configured.
So I suggest you use the best HTTP client for the technology you use. To configure it to target your Strapi API.
Here so usefull ressources to help you:
- [**API Endpoints**](https://strapi.io/documentation/3.0.0-beta.x/guides/api-endpoints.html#endpoints)
- [**URL parameters**](https://strapi.io/documentation/3.0.0-beta.x/guides/parameters.html)
---
The official Strapi SDK for JavaScript, available for browsers or Node.js backends.
---
## Install
```sh
npm install strapi-sdk-javascript
```
## Start now
### New instance
```js
import Strapi from 'strapi-sdk-javascript';
const strapi = new Strapi('http://localhost:1337');
```
### Authentications
#### Local
```js
await strapi.login('username_or_email', 's3cr3t');
```
#### [Providers](https://strapi.io/documentation/guides/authentication.html#providers)
```js
// Redirect your user to the provider's authentication page.
window.location = strapi.getProviderAuthenticationUrl('facebook');
```
Once authorized, the provider will redirects the user to your app with an access token in the URL.
```js
// Complete the authentication: (The SDK will store the access token for you)
await strapi.authenticateProvider('facebook');
```
You can now fetch private APIs
```js
const posts = await strapi.getEntries('posts');
```
### Files management
#### Browser
```js
const form = new FormData();
form.append('files', fileInputElement.files[0], 'file-name.ext');
form.append('files', fileInputElement.files[1], 'file-2-name.ext');
const files = await strapi.upload(form);
```
#### Node.js
```js
const FormData = require('form-data');
const fs = require('fs');
const form = new FormData();
form.append('files', fs.createReadStream('./file-name.ext'), 'file-name.ext');
const files = await strapi.upload(form, {
headers: form.getHeaders()
});
```
## API
### `Strapi(baseURL, storeConfig, requestConfig)`
### `request(method, url, requestConfig)`
### `register(username, email, password)`
### `login(identifier, password)`
### `forgotPassword(email, url)`
### `resetPassword(code, password, passwordConfirmation)`
### `getProviderAuthenticationUrl(provider)`
### `authenticateProvider(provider, params)`
### `setToken(token, comesFromStorage)`
### `clearToken(token)`
### `getEntries(contentTypePluralized, params)`
### `getEntry(contentTypePluralized, id)`
### `getEntryCount(contentTypePluralized, params)`
### `createEntry(contentTypePluralized, data)`
### `updateEntry(contentTypePluralized, id, data)`
### `deleteEntry(contentTypePluralized, id)`
### `searchFiles(query)`
### `getFiles(params)`
### `getFile(id)`
### `upload(data)`
#### requestConfig
Custom axios request configuration. [See documentation](https://github.com/axios/axios#request-config)
## Resources
* [Documentation](https://strapi.github.io/strapi-sdk-javascript)
* [Changelog](https://github.com/strapi/strapi-sdk-javascript/blob/master/CHANGELOG.md)
* [Medium story](https://medium.com/strapi/announcing-the-strapi-javascript-sdk-ac89f140a9d1)
## Roadmap
* GraphQL
* Attach/Detach entry relationship
* Real time with Socket.io
## Credits
* [axios](https://github.com/axios/axios)
* [typescript-starter](https://github.com/bitjson/typescript-starter)
## License
MIT