MCPcopy Index your code
hub / github.com/claudiajs/claudia-api-builder

github.com/claudiajs/claudia-api-builder @v3.0.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v3.0.2 ↗ · + Follow
44 symbols 96 edges 16 files 0 documented · 0% 2 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Claudia API Builder

npm npm npm Build Status Join the chat at https://gitter.im/claudiajs/claudia

Claudia API Builder makes it possible to use AWS API Gateway as if it were a lightweight JavaScript web server, so it helps developers get started easily and reduces the learning curve required to launch web APIs in AWS. Check out this video to see how to create and deploy an API in under 5 minutes.

Claudia.js Introduction Video

The API Builder helps you by:

  • setting up AWS API Gateway Web interfaces for Lambda projects easily, the way JavaScript developers expect out of the box
  • routing multiple AWS API Gateway end-points to a single Lambda function, so that you can develop and deploy an entire API simpler and avoid inconsistencies.
  • handling synchronous responses or asynchronous promises, so you can develop easier
  • configuring response content types and HTTP codes easily
  • enabling you to set-up post-install configuration steps, so that you can set up the deployments easier

The API builder is designed to work with Claudia, and add minimal overhead to client projects.

Simple example

var ApiBuilder = require('claudia-api-builder'),
    api = new ApiBuilder(),
    superb = require('superb');

module.exports = api;

api.get('/greet', function (request) {
    return request.queryString.name + ' is ' + superb();
});

For a more examples, see the Web API Example Projects

Getting started

  • Check out the Getting Started guide for a basic Hello-World style example
  • Check out the API Documentation for a detailed guide on handling requests, customising responses and configuring your API

Questions, suggestions?

Join the chat at https://gitter.im/claudiajs/claudia

License

MIT

Core symbols most depended-on inside this repo

responseHeaders
called by 43
spec/api-builder-spec.js
responseBody
called by 30
spec/api-builder-spec.js
responseStatusCode
called by 27
spec/api-builder-spec.js
contentType
called by 21
spec/api-builder-spec.js
waitFor
called by 10
spec/sequential-promise-map-spec.js
isApiResponse
called by 9
src/api-builder.js
safeStringify
called by 3
src/api-builder.js
v2DeprecationWarning
called by 3
src/api-builder.js

Shape

Function 44

Languages

TypeScript100%

Modules by API surface

src/api-builder.js28 symbols
spec/api-builder-spec.js5 symbols
src/convert-api-gw-proxy-request.js4 symbols
spec/sequential-promise-map-spec.js3 symbols
src/sequential-promise-map.js2 symbols
src/merge-vars.js1 symbols
spec/support/jasmine-runner.js1 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

For agents

$ claude mcp add claudia-api-builder \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact