resource-x

Resource and domain modeling for quick APIs, CMSs, and applications.

View the Project on GitHub khalidx/resource-x

resource-x

Resource and domain modeling for quick APIs, CMSs, and applications.

GitHub package.json dynamic

GitHub GitHub package.json version GitHub top language

GitHub last commit

Quick start

Deploy an API to the cloud in under 30 seconds, in just 3 steps.

tutorial

1) Build your domain objects as JSON Schemas, all in the same Markdown document. Alternatively, run rx init to get a ready-to-use document with two sample schemas.

2) When you run rx generate sample.md, you’ll get a full CRUD (create-read-update-delete) Swagger specification for your API.

3) You can then deploy your specification to AWS API Gateway, complete with request validation and mock responses, with a single rx deploy sample.md command.

How easy was that?

Features

Installation

Installing is easy with npm.

npm install -g @khalidx/resource-x

Alternatively, you can also download a binary for your operating system.

Windows, Mac, and Linux are all supported.

Usage

Initialize a new sample project in the current directory.

rx init

init

Generate an API specification from the document file.

rx generate <file>

generate

Opens the browser to view the resources in the document file.

rx browse <file>

browse

Deploy the API with mock integration to AWS API Gateway.

rx deploy <file>

deploy

Undeploy the API from AWS API Gateway.

rx undeploy <file>

undeploy

Remove the generated .rx/ directory.

rx clean

clean

See help and usage information about all available commands.

rx --help

help

Pro tips and tricks

Support

Open a GitHub issue to ask a question, report a bug, raise a concern, or request a new feature.

Also, your question may already be answered on the following Hacker News thread.