yipp

Use a GQL-inspired syntax to build a schema-first driven REST API.

# schema.yipp

type FieldError {
  field: String!
  message: String!
}

type Error {
  message: String!
  fields: [FieldError!]!
} 

enum UserType {
  admin
  user
}
  
login: POST /login {
  body: {
    username: String!
    password: String!
  }
  200: {
    body: {
      token: String!
    }
  }
  400: {
    body: Error
  }
} 

getUser: GET /users/:id(Int) {
  headers: {
    authorization: String!
  }
  
  200: {
    body: {
      id: Int!
      username: String!
      type: UserType!
    }
  }

  400: {
    body: Error
  }
}

Install and usage

npm install -g yipp
yipp axios-client output.ts schema.yipp

CLI

Can be used to generate different clients, servers, etc.

Example of generators using this schema:

• fastify-plugin - Fastify Plugin
• axios-client - HTTP Client using Axios

Usage: yipp [options] <type> <output-file> <input-file...>

generate

Arguments:
  type         (choices: "fastify-plugin", "axios-client")
  output-file  generated typescript file
  input-file   One or more api schema files. Will be merged into one schema if several files.

Options:
  -w --watch   watch for changes (default: false)
  -h, --help   display help for command

🐄