Function makeHttpApi

makeHttpApi<
    ReqHeadersT extends AnyHeaders = undefined,
    ReqParamsT extends AnyParams = undefined,
    ReqQueryT extends AnyQuery = undefined,
    ReqBodyT extends unknown = undefined,
    ResStatusT extends number = number,
    ResHeadersT extends AnyHeaders = undefined,
    ResBodyT extends unknown = undefined,
    ErrResStatusT extends number = number,
    ErrResHeadersT extends AnyHeaders = undefined,
    ErrResBodyT extends unknown = undefined,
>(
    api: Omit<
        HttpApi<
            ReqHeadersT,
            ReqParamsT,
            ReqQueryT,
            ReqBodyT,
            ResStatusT,
            ResHeadersT,
            ResBodyT,
            ErrResStatusT,
            ErrResHeadersT,
            ErrResBodyT,
        >,
        "isYaschemaApi"
        | "name"
        | "isYaschemaHttpApi",
    > & { name?: string },
): HttpApi<
    ReqHeadersT,
    ReqParamsT,
    ReqQueryT,
    ReqBodyT,
    ResStatusT,
    ResHeadersT,
    ResBodyT,
    ErrResStatusT,
    ErrResHeadersT,
    ErrResBodyT,
>
If name is omitted, it will be generated as:
```
`HTTP ${api.routeType}:${api.method} ${api.url}`
```
Type Parameters
- ReqHeadersT extends AnyHeaders = undefined
- ReqParamsT extends AnyParams = undefined
- ReqQueryT extends AnyQuery = undefined
- ReqBodyT extends unknown = undefined
- ResStatusT extends number = number
- ResHeadersT extends AnyHeaders = undefined
- ResBodyT extends unknown = undefined
- ErrResStatusT extends number = number
- ErrResHeadersT extends AnyHeaders = undefined
- ErrResBodyT extends unknown = undefined
Parameters
- api: Omit<
      HttpApi<
          ReqHeadersT,
          ReqParamsT,
          ReqQueryT,
          ReqBodyT,
          ResStatusT,
          ResHeadersT,
          ResBodyT,
          ErrResStatusT,
          ErrResHeadersT,
          ErrResBodyT,
      >,
      "isYaschemaApi"
      | "name"
      | "isYaschemaHttpApi",
  > & { name?: string }
Returns HttpApi<
    ReqHeadersT,
    ReqParamsT,
    ReqQueryT,
    ReqBodyT,
    ResStatusT,
    ResHeadersT,
    ResBodyT,
    ErrResStatusT,
    ErrResHeadersT,
    ErrResBodyT,
>
- Defined in type-makers/make-http-api.ts:14

Function makeHttpApi

Type Parameters

Parameters

Returns HttpApi< ReqHeadersT, ReqParamsT, ReqQueryT, ReqBodyT, ResStatusT, ResHeadersT, ResBodyT, ErrResStatusT, ErrResHeadersT, ErrResBodyT,>

Settings

Returns HttpApi<
ReqHeadersT,
ReqParamsT,
ReqQueryT,
ReqBodyT,
ResStatusT,
ResHeadersT,
ResBodyT,
ErrResStatusT,
ErrResHeadersT,
ErrResBodyT,
>