REST

Overview

code.store platform support file based REST endpoints. To avoid manual file creation allowed a command cs generate:rest, which generate an empty route template with handler method.

To generate REST route just execute cs generate:rest CLI command, select one of HTTP methods: GET, POST, PUT, DELETE and specify a new route name

> cs generate:rest

? Select HTTP method (Use arrow keys)
❯ GET 
  POST 
  PUT 
  DELETE 
  
? Select HTTP method GET

? Name of your REST endpoint hello

Also, you can use flags:

-m for method specification (GET, POST, PUT, DELETE)

-n for route name

For example, here a command from previous example: cs generate:rest -m get -n hello

After command execution will be generated file get.hello.ts in src/rest directory:

/**
 * This handler was generated by code.store CLI.
 *
 * Visit our documentation to learn more about the support of REST APIs in our SDK:
 * https://docs.code.store/getting-started/sdk/rest-apis
 *
 * You can also join our community at https://spectrum.chat/code-store if you have any
 * questions which are not covered by the documentation.
 *
 */

import { Handler } from 'codestore-utils';

const handler: Handler = async (event, context) => {
  // your code goes here
  return 'Hello, world!';
}

export default handler;

More information about handler method and his params can be found in REST section.