Repository files navigation

The best way to create REST APIs (is GraphQL).

yarn add sofa-api# ornpm install sofa-api

Here's complete example with no dependency on frameworks, but also integratable with any of them:

importhttpfrom'http';importgetStreamfrom'get-stream';import{useSofa}from'sofa-api';constserver=http.createServer(useSofa({basePath:'/api',    schema,}));

Another example with builtin express-like frameworks support

import{useSofa}from'sofa-api';importexpressfrom'express';constapp=express();app.use('/api',useSofa({basePath:'/api',    schema,}));// GET /api/users// GET /api/messages

Sofa takes your GraphQL Schema, looks for available queries, mutations and subscriptions and turns all of that into REST API.

Given the following schema:

typeChat {id:IDtext:String}typeQuery {chat(id:ID):Chatchats: [Chat]me:ChatrecentChats: [Chat]}

Routes that are being generated:

GET /chat/:idGET /chatsGET /meGET /recent-chats

Sofa treats some types differently than others, those are called Models.

The idea behind Models is to not expose full objects in every response, especially if it's a nested, not first-level data.

For example, when fetching a list of chats you don't want to include all messages in the response, you want them to be just IDs (or links). Those messages would have to have their own endpoint. We call this type of data, a Model. In REST you probably call them Resources.

In order to treat particular types as Models you need to provide two queries, one that exposes a list (with no non-optional arguments) and the other to fetch a single entity (id field as an argument). The model itself has to have anid field. Those are the only requirements.

# Message is treated as a ModeltypeQuery {messages: [Message]message(id:ID):Message}typeMessage {id:ID  # other fields ...}

In order for Sofa to resolve operations based on a Context, you need te be able to provide some. Here's how you do it:

api.use('/api',useSofa({basePath:'/api',    schema,asynccontext({ req}){return{        req,        ...yourContext,};},}));

You can pass a plain object or a function.

There are some cases where sending a full object makes more sense than passing only the ID. Sofa allows you to easily define where to ignore the default behavior:

api.use('/api',useSofa({basePath:'/api',    schema,ignore:['Message.author'],}));

Whenever Sofa tries to resolve an author of a message, instead of exposing an ID it will pass whole data.

Pattern is easy:Type.field orType

Sofa allows you to cutomize the http method, path and response status. For example, in case you needPOST instead ofGET method in one of your query, you do the following:

api.use('/api',useSofa({    schema,routes:{'Query.feed':{method:'POST'},},}));

When Sofa tries to define a route forfeed ofQuery, instead of exposing it underGET (default for Query type) it will usePOST method.

Pattern is easy:Type.field whereType is your query or mutation type.

You can also specifypath with dynamic params support (for example/feed/:offset/:limit) andresponseStatus.

Sofa prevents circular references by default, but only one level deep. In order to change it, set thedepthLimit option to any number:

api.use('/api',useSofa({basePath:'/api',    schema,depthLimit:2,}));

By default, Sofa usesgraphql function fromgraphql-js to turn an operation into data but it's very straightforward to pass your own logic. Thanks to that you can even use a remote GraphQL Server (with Fetch or through Apollo Links).

api.use('/api',useSofa({basePath:'/api',    schema,asyncexecute(args){returnyourOwnLogicHere(args);},}));

Sofa enables you to run GraphQL Subscriptions through WebHooks. It has a special API to start, update and stop a subscription.

• POST /webhook - starts a subscription
• DELETE /webhook/:id - stops it
• POST /webhook/:id- updates it

To start a new subscription you need to include following data in request's body:

• subscription - subscription's name, matches the name in GraphQL Schema
• variables - variables passed to run a subscription (optional)
• url - an url of your webhook receiving endpoint

After sending it toPOST /webhook you're going to get in return a unique ID that is your started subscription's identifier.

{"id":"SUBSCRIPTION-UNIQUE-ID"}

In order to stop a subscription, you need to pass its id and hitDELETE /webhook/:id.

Updating a subscription looks very similar to how you start one. Your request's body should contain:

• variables - variables passed to run a subscription (optional)

After sending it toPOST /webhook/:id you're going to get in return a new ID:

{"id":"SUBSCRIPTION-UNIQUE-ID"}

Given the following schema:

typeSubscription {onBook:Book}

Let's start a subscription by sending that toPOST /webhook:

{"subscription":"onBook","variables": {},"url":"https://app.com/new-book"}

In return we get anid that we later on use to stop or update subscription:

DELETE /webhook/:id

Thanks to GraphQL's Type System Sofa is able to generate OpenAPI (Swagger) definitions out of it. Possibilities are endless here. You get all the information you need in order to write your own definitions or create a plugin that follows any specification.

import{useSofa,OpenAPI}from'sofa-api';import{writeFileSync}from'fs';constopenApi=OpenAPI({  schema,info:{title:'Example API',version:'3.0.0',},});app.use('/api',useSofa({basePath:'/api',    schema,onRoute(info){openApi.addRoute(info,{basePath:'/api',});},}));// writes every recorder routewriteFileSync('./swagger.json',JSON.stringify(openApi.get(),null,2));

OpenAPI (Swagger) with Bearer Authentication

import{useSofa,OpenAPI}from'sofa-api';import{writeFileSync}from'fs';constopenApi=OpenAPI({  schema,info:{title:'Example API',version:'3.0.0',},components:{securitySchemes:{bearerAuth:{type:'http',scheme:'bearer',bearerFormat:'JWT',},},},security:[{bearerAuth:[],},],});app.use('/api',useSofa({basePath:'/api',    schema,onRoute(info){openApi.addRoute(info,{basePath:'/api',});},}));// writes every recorder routewriteFileSync('./swagger.json',JSON.stringify(openApi.get(),null,2));

OpenAPI (Swagger) with custom tags, summary and description

constopenApi=OpenAPI({  schema,info:{title:'Example API',version:'3.0.0',},tags:[{name:'Book',description:'Book related operations',},{name:'Author',description:'Author related operations',},],});

@Resolver(Book)exportclassBookResolver{  @Query(()=>Book,{description:'Get book by id'})// custom summary taggetBookById(@Arg('id',()=>Int)id:number){return'book';}}

constroutes:SofaConfig['routes']={'Query.getBookById':{method:'POST',path:'/book/:id',tags:['Book'],description:'This is a custom detailed description for getBookById',},};constcreateSofaMiddleware=(schema:GraphQLSchema,openApi:ReturnType<typeofOpenAPI>,basePath=''):ReturnType<typeofuseSofa>=>{returnuseSofa({    routes,    basePath,    schema,onRoute(info){openApi.addRoute(info,{ basePath});},});};// writes every recorder routeopenApi.save('./swagger.yml');

MIT © Uri Goldshtein