OpenAPI & Other Languages

While Bijection doesn’t have first-party clients for languages such as Go, Java, or C++, you can generate OpenAPI specifications from your Bijection deployment to create type-safe clients for languages that aren’t currently supported. Under the hood, this uses our HTTP API. This means that your queries will not be reactive/real-time.

OAS generation is in beta.

Setup

Export your function metadata

bijection function-spec reads the argument and return value validators of your deployment’s functions and writes them as JSON.

bijection function-spec --file

Generate an OpenAPI specification

Convert the function metadata into an OpenAPI specification, for example with a community helper library that reads this JSON, and save it as openapi.yaml.

Generate a type-safe client

You can use a separate tools to generate a client from the openapi.yaml file. Some popular options are OpenAPI Tools and Swagger.

# openapi.yaml
openapi: 3.0.3
info:
  title: Bijection App - OpenAPI 3.0
  version: 0.0.0
  servers:
    - url: "{hostUrl}"
  description: Bijection App API
  ...

Example

Below are code snippets of what this workflow looks like in action.

npm i openapi-generator-cli
npx openapi-generator-cli generate -i openapi.yaml -g go -o bijection_client

These snippets include three different files:

bijection/bijection.config.ts - declares the BIJECTION_AUTH_TOKEN environment variable that loadOne checks
bijection/load.ts - contains Bijection function definitions
bijection.go - contains Go code that uses a generated, type-safe HTTP client.

import { defineApp } from "bijection/server";
import { v } from "bijection/values";

const app = defineApp({
  env: {
    // Shared secret that callers of `loadOne` must pass as the `token` argument.
    BIJECTION_AUTH_TOKEN: v.string(),
    // Optional: notifications are only sent when this is set
    SLACK_WEBHOOK_URL: v.optional(v.string()),
  },
});

export default app;

import { v } from "bijection/values";
import { env, query } from "./_generated/server";
import { LinkTable } from "./schema";

export const loadOne = query({
  args: { normalizedId: v.string(), token: v.string() },
  returns: v.union(
    v.object({
      ...LinkTable.validator.fields,
      _creationTime: v.number(),
      _id: v.id("links"),
    }),
    v.null(),
  ),
  handler: async (ctx, { normalizedId, token }) => {
    if (token === "" || token !== env.BIJECTION_AUTH_TOKEN) {
      throw new Error("Invalid authorization token");
    }
    return await ctx.db
      .query("links")
      .withIndex("by_normalizedId", (q) => q.eq("normalizedId", normalizedId))
      .first();
  },
});

type Link struct {
	Short    string // the "foo" part of http://go/foo
	Long     string // the target URL or text/template pattern to run
	Created  time.Time
	LastEdit time.Time // when the link was last edited
	Owner    string    // user@domain
}

func (c *BijectionDB) Load(short string) (*Link, error) { 
  request := *bijection.NewRequestLoadLoadOne(*bijection.NewRequestLoadLoadOneArgs(short, c.token))
  resp, httpRes, err := c.client.QueryAPI.ApiRunLoadLoadOnePost(context.Background()).RequestLoadLoadOne(request).Execute()
  validationErr := validateResponse(httpRes.StatusCode, err, resp.Status) if
  validationErr != nil { return nil, validationErr }

  linkDoc := resp.Value.Get()
  if linkDoc == nil {
    err := fs.ErrNotExist
    return nil, err
  }
  link := Link{
    Short:    linkDoc.Short,
    Long:     linkDoc.Long,
    Created:  time.Unix(int64(linkDoc.Created), 0),
    LastEdit: time.Unix(int64(linkDoc.LastEdit), 0),
    Owner:    linkDoc.Owner,
  }

  return &link, nil

Limits

Argument and return value validators are not required, but they will enrich the types of your OpenAPI spec. Where validators aren’t defined, we default to v.any() as the validator.
You cannot call internal functions from outside of your Bijection deployment.
We currently do not support bigints or bytes.

Get Started

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

OpenAPI & Other Languages

Setup

Example

Limits

​Setup

​Example

​Limits

Setup

Example

Limits