Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adjust code style on readme examples #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adjust code style on readme examples #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ import { ApiService } from '@apicase/services'

const SomeService = new ApiService({
adapter: fetch,
url: '/api/posts'
method: 'GET'
url: '/api/posts',
method: 'GET',
})

// { "url": "/api/posts", "method": "GET", "query": { "userId": 1 } }
Expand All @@ -46,7 +46,7 @@ const api = new ApiTree([
{ name: 'createPost', url: '', method: 'POST' },
{ name: 'getOnePost', url: ':id', method: 'GET' },
{ name: 'updateOnePost', url: ':id', method: 'PUT' },
{ name: 'removeOnePost', url: ':id', method: 'REMOVE' }
{ name: 'removeOnePost', url: ':id', method: 'REMOVE' },
] },
{ url: 'profile', children: [...] }
] }
Expand All @@ -69,7 +69,7 @@ const api = new ApiTree(Root, [
{ name: 'createPost', url: '', method: 'POST' },
{ name: 'getOnePost', url: ':id', method: 'GET' },
{ name: 'updateOnePost', url: ':id', method: 'PUT' },
{ name: 'removeOnePost', url: ':id', method: 'REMOVE' }
{ name: 'removeOnePost', url: ':id', method: 'REMOVE' },
] },
{ url: 'profile', children: [...] }
])
Expand All @@ -89,11 +89,11 @@ Alternative way to avoid _string_ api (but there are no `children` option):
import { ApiObjectTree } from '@apicase/services'

const api = new ApiTree(BaseService, {
getAllPosts: { url: '' },
createPost: { url: '', method: 'POST' },
getOnePost: { url: ':id', method: 'POST' },
updOnePost: { url: ':id', method: 'PUT' },
rmvOnePost: { url: ':id', method: 'DELETE' }
getAllPosts: { url: '' },
createPost: { url: '', method: 'POST' },
getOnePost: { url: ':id', method: 'POST' },
updOnePost: { url: ':id', method: 'PUT' },
rmvOnePost: { url: ':id', method: 'DELETE' },
})

api.getAllPosts.doRequest()
Expand All @@ -105,7 +105,7 @@ api.createPost.doRequest({ body })
Helper to work with REST APIs just automatically generates urls, methods and names

```javascript
import { ApiTree, rest } from "@apicase/services"
import { ApiTree, rest } from '@apicase/services'

/*
If you are lucky - default structure doesn't need to write URL's
Expand All @@ -115,32 +115,32 @@ import { ApiTree, rest } from "@apicase/services"
postsUpdOne: PUT /:id
postsRmvOne: DELETE /:id
*/
const posts = rest("posts", ["getAll", "getOne", "create", "updOne", "rmvOne"])
const posts = rest('posts', ['getAll', 'getOne', 'create', 'updOne', 'rmvOne'])

/* Skip 2nd argument to get just all routes */
const posts = rest("posts")
const posts = rest('posts')

/* Otherwise, still OK */
const profile = rest("profile", {
getAll: { url: "we/have" },
create: { url: "custom/routes" },
getOne: { url: "no_refactoring/:id" },
updOne: { url: "since_2008/:id" },
rmvOne: { url: "legacy_shit" }
const profile = rest('profile', {
getAll: { url: 'we/have' },
create: { url: 'custom/routes' },
getOne: { url: 'no_refactoring/:id' },
updOne: { url: 'since_2008/:id' },
rmvOne: { url: 'legacy_shit' },
})

new ApiTree(Root, [
{ url: "posts", children: posts },
{ url: "profile", children: profile }
{ url: 'posts', children: posts },
{ url: 'profile', children: profile },
])
```

`wrappedRest` helper is similar to `rest` but also wraps it into url with name:

```javascript
import { ApiTree, wrappedRest } from "@apicase/services"
import { ApiTree, wrappedRest } from '@apicase/services'

new ApiTree(Root, [wrappedRest("posts"), wrappedRest("profile")])
new ApiTree(Root, [wrappedRest('posts'), wrappedRest('profile')])
```

## License
Expand Down