yaschema-api
TypeScript icon, indicating that this package has built-in type declarations

3.6.2 • Public • Published

yaschema-api

Downloads Size

Yet another API. Schema-first API modeling and validation for TypeScript, built on yaschema.

This package is almost entirely TypeScript types, except for a few configuration functions and utilities. Yaschema-APIs have routeType metadata, which is helpful for directing traffic to different sets of servers. See setUrlBaseForRouteType and setDefaultUrlBase.

Support for handling yaschema-api requests server side and for making yaschema-api requests either client or server side, is handled by other packages.

We love TypeScript and use it pretty much everywhere. We use it for our React Native app, our React web app, as well as for our server.

We built yaschema-api as part of our type and API spec system, to be TypeScript first -- and to still conveniently support code generation and OpenAPI spec generation as needed.

Because yaschema-api leverages yaschema, you can define both runtime and compile-time validated types with a single definition.

Basic Example

export const POST = makeHttpApi({
  method: 'POST',
  routeType: 'rest',
  url: '/ping',
  isSafeToRetry: true,
  schemas: {
    request: {
      body: schema.object({
        echo: schema.string().allowEmptyString().optional()
      })
    },
    successResponse: {
      status: schema.number(StatusCodes.OK),
      body: schema.string()
    }
  }
});

Thanks

Thanks for checking it out. Feel free to create issues or otherwise provide feedback.

API Docs

Be sure to check out our other TypeScript OSS projects as well.

Package Sidebar

Install

npm i yaschema-api

Weekly Downloads

11

Version

3.6.2

License

MIT

Unpacked Size

149 kB

Total Files

350

Last publish

Collaborators

  • bwestphal