https://github.com/jheising/api-2-love
The easiest way to create an API to ❤
https://github.com/jheising/api-2-love
api nodejs nodejs-api typescript
Last synced: 15 days ago
JSON representation
The easiest way to create an API to ❤
- Host: GitHub
- URL: https://github.com/jheising/api-2-love
- Owner: jheising
- Created: 2022-05-18T03:58:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T04:42:58.000Z (about 3 years ago)
- Last Synced: 2025-02-26T06:36:17.112Z (over 1 year ago)
- Topics: api, nodejs, nodejs-api, typescript
- Language: TypeScript
- Homepage:
- Size: 475 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# api-2-love
The easiest way to create an API to ❤️ — the successor to [apilove](https://www.npmjs.com/package/apilove).
## Installing
`npm i api-2-love`
You may also install `ts-node` or `ts-node-dev` to make local development easier.
---
## Getting Started (TypeScript)
First create a file in the root of your project called `server.ts`, then add the following lines:
```typescript
import {API2Love} from "api-2-love";
exports.handler = new API2Love().handler;
```
That's all you need to do to create an API that runs as either a stand-alone server or a serverless Lambda function.
API2Love will automatically determine what environment it's running in and set itself up properly to handler API
requests.
To run your API service locally all you need to do is run `ts-node server.ts`, or if you want to get really fancy you
can use `ts-node-dev --watch ./api,./src --transpile-only server.ts` to run your server and automatically
restart it when it detects changes.
---
## Building your API Code
### Routes
API2Love uses route handling logic similar to Next.js in order to define your API routes. By default, API2Love
looks for source files in the `./api` directory. The following are some examples of how this works:
`./api/admin/index.ts` or `./api/admin.ts` would be available at `https://myapi.com/admin`
`./api/orders/newest/index.ts` or `./api/orders/newest.ts` would be available at `https://myapi.com/orders/newest`
You can also use route parameters like:
`./api/orders/[orderID]/index.ts` or `./api/orders/[orderID].ts` would be available
at `https://myapi.com/orders/1828972`
### Code
To write the code to handle your API requests, you simply export a default class.
Here is a simple example:
```typescript
// From ./api/orders/[orderID]/index.ts
import {Path, Query, Optional} from "api-2-love";
export default class OrderAPI {
static async getOrderByID(
@Path // This means the variable named orderID will be pulled from the path of the route
orderID: string,
@Query // This means the variable named verbose will be pulled from a query parameter
@Optional // By default, all variables are required and will return an error if not specified. This denotes that this variable is optional.
verbose?: boolean
) {
return MyOrderSystem.getOrderByID(orderID, verbose);
}
}
```
---
More documentation coming soon...