Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
TypeScript friendly HTTP client wrapper for the browser and node.js.
Since aspida >= 0.18.0
, the property data
of the request and response has been changed to body
.
const { body } = await client.v1.users.post({ body: { name: "taro" } })
const body = await client.v1.users.$post({ body: { name: "taro" } })
0.8.0
0.6.0
0.6.0
0.5.0
0.8.0
$ mkdir api
GET: /v1/users/?limit={number}
POST: /v1/users
api/v1/users/index.ts
type User = {
id: number
name: string
}
export type Methods = {
get: {
query?: {
limit: number
}
resBody: User[]
}
post: {
reqBody: {
name: string
}
resBody: User
}
}
GET: /v1/users/${userId}
PUT: /v1/users/${userId}
api/v1/users/_userId@number/index.ts
Specify the type of path variable “userId” starting with underscore with “@number”
If not specified with @, the default path variable type is "number | string"
type User = {
id: number
name: string
}
export type Methods = {
get: {
resBody: User
}
put: {
reqBody: {
name: string
}
resBody: User
}
}
package.json
{
"scripts": {
"api:build": "aspida"
}
}
$ npm run api:build
> api/$api.ts was built successfully.
src/index.ts
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const userId = 0
const limit = 10
const client = api(aspida())
await client.v1.users.post({ body: { name: "taro" } })
const res = await client.v1.users.get({ query: { limit } })
console.log(res)
// req -> GET: /v1/users/?limit=10
// res -> { status: 200, body: [{ id: 0, name: "taro" }], headers: {...} }
const user = await client.v1.users._userId(userId).$get()
console.log(user)
// req -> GET: /v1/users/0
// res -> { id: 0, name: "taro" }
})()
Option | Type | Default | Description |
---|---|---|---|
--config -c | string | "aspida.config.js" | Specify the path to the configuration file. |
--watch -w |
Enable watch mode. Regenerate $api.ts according to
the increase / decrease of the API endpoint file.
| ||
--version -v | Print aspida version. |
Option | Type | Default | Description |
---|---|---|---|
input | string | "api", "apis" | Specifies the endpoint type definition root directory |
baseURL | string | "" | Specify baseURL of the request |
trailingSlash | boolean | false | Append / to the request URL |
outputEachDir | boolean | false | Generate $api.ts in each endpoint directory |
import { version, build, watch } from "aspida/dist/commands"
console.log(version()) // 0.x.y
build()
build("./app/aspida.config.js")
build({ input: "api1" })
build([
{ baseURL: "https://example.com/v1" },
{
input: "api2",
baseURL: "https://example.com/v2",
trailingSlash: true,
outputEachDir: true
}
])
watch()
watch("./app/aspida.config.js")
watch({ input: "api1" })
watch([
{ baseURL: "https://example.com/v1" },
{
input: "api2",
baseURL: "https://example.com/v2",
trailingSlash: true,
outputEachDir: true
}
])
Create a configuration file at the root of the project
aspida.config.js
module.exports = { input: "src" }
Specify baseURL in configuration file
module.exports = { baseURL: "https://example.com/api" }
If you want to define multiple API endpoints, specify them in an array
module.exports = [
{ input: "api1" },
{ input: "api2", baseURL: "https://example.com/api" }
]
aspida leaves GET parameter serialization to standard HTTP client behavior
If you want to serialize manually, you can use config object of HTTP client
src/index.ts
import axios from "axios"
import qs from "qs"
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const client = api(
aspida(axios, { paramsSerializer: params => qs.stringify(params, { indices: false }) })
)
const users = await client.v1.users.$get({
// config: { paramsSerializer: (params) => qs.stringify(params, { indices: false }) },
query: { ids: [1, 2, 3] }
})
console.log(users)
// req -> GET: /v1/users/?ids=1&ids=2&ids=3
// res -> [{ id: 1, name: "taro1" }, { id: 2, name: "taro2" }, { id: 3, name: "taro3" }]
})()
api/v1/users/index.ts
export type Methods = {
post: {
reqFormat: FormData
reqBody: {
name: string
icon: Blob
}
resBody: {
id: number
name: string
}
}
}
src/index.ts
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const client = api(aspida())
const user = await client.v1.users.$post({
body: {
name: "taro",
icon: imageBlob
}
})
console.log(user)
// req -> POST: h/v1/users
// res -> { id: 0, name: "taro" }
})()
api/v1/users/index.ts
export type Methods = {
post: {
reqFormat: URLSearchParams
reqBody: {
name: string
}
resBody: {
id: number
name: string
}
}
}
src/index.ts
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const client = api(aspida())
const user = await client.v1.users.$post({ body: { name: "taro" } })
console.log(user)
// req -> POST: /v1/users
// res -> { id: 0, name: "taro" }
})()
api/v1/users/index.ts
export type Methods = {
get: {
query: {
name: string
}
resBody: ArrayBuffer
}
}
src/index.ts
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const client = api(aspida())
const user = await client.v1.users.$get({ query: { name: "taro" } })
console.log(user)
// req -> GET: /v1/users/?name=taro
// res -> ArrayBuffer
})()
Compatible with yaml/json of OpenAPI3.0/Swagger2.0
tarminal
$ npx openapi2aspida -i https://petstore.swagger.io/v2/swagger.json
# api/$api.ts was built successfully.
Special characters are encoded as percent-encoding in the file name
Example ":"
-> "%3A"
api/foo%3Abar/index.ts
export type Methods = {
get: {
resBody: string
}
}
With clients, "%3A"
-> "_3A"
src/index.ts
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const client = api(aspida())
const message = await client.foo_3Abar.$get()
console.log(message)
// req -> GET: /foo%3Abar (= /foo:bar)
})()
If you don't need to use all of api/$api.ts
, you can split them up and import only part of them
outputEachDir
option generates $api.ts
in each endpoint directory
$api.ts
will not be generated under the directory containing the path variable
aspida.config.js
module.exports = { outputEachDir: true }
Import only $api.ts
of the endpoint you want to use and put it into Object
src/index.ts
import aspida from "@aspida/axios"
import api0 from "../api/v1/foo/$api"
import api1 from "../api/v2/bar/$api"
;(async () => {
const aspidaClient = aspida()
const client = {
foo: api0(aspidaClient),
bar: api1(aspidaClient)
}
const message = await client.bar._id(1).$get()
// req -> GET: /v2/bar/1
})()
src/index.ts
import aspida from "@aspida/axios"
import api from "../api/$api"
;(async () => {
const client = api(aspida())
console.log(client.v1.users.$path())
// /v1/users
console.log(client.vi.users.$path({ query: { limit: 10 } }))
// /v1/users?limit=10
console.log(client.vi.users.$path({
method: 'post',
query: { id: 1 }
}))
// /v1/users?id=1
})()
api/index.ts
/**
* root comment
*
* @remarks
* root remarks comment
*/
export type Methods = {
/**
* post method comment
*
* @remarks
* post method remarks comment
*/
post: {
/** post query comment */
query: { limit: number }
/** post reqHeaders comment */
reqHeaders: { token: string }
reqFormat: FormData
/** post reqBody comment */
reqBody: UserCreation
/**
* post resBody comment1
* post resBody comment2
*/
resBody: User
}
}
$ npm run api:build
api/$api.ts
/**
* root comment
*
* @remarks
* root remarks comment
*/
const api = <T>({ baseURL, fetch }: AspidaClient<T>) => {
return {
/**
* post method comment
*
* @remarks
* post method remarks comment
*
* @param option.query - post query comment
* @param option.headers - post reqHeaders comment
* @param option.body - post reqBody comment
* @returns post resBody comment1
* post resBody comment2
*/
$post: (option: { body: Methods0['post']['reqBody'], query: Methods0['post']['query'], headers: Methods0['post']['reqHeaders'], config?: T }) =>
fetch<Methods0['post']['resBody']>(prefix, PATH0, POST, option).json().then(r => r.body)
}
}
aspida is licensed under a MIT License.
FAQs
TypeScript friendly HTTP client wrapper for the browser and node.js
The npm package aspida receives a total of 19,723 weekly downloads. As such, aspida popularity was classified as popular.
We found that aspida demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.