https://github.com/coding-nerfilio/my-tiny-api

my-tiny-api is a Node.js package designed to scaffold a Express CRUD API REST for TypeORM entities with validation.
https://github.com/coding-nerfilio/my-tiny-api

express nodejs rest-api typeorm

Last synced: 2 days ago
JSON representation

my-tiny-api is a Node.js package designed to scaffold a Express CRUD API REST for TypeORM entities with validation.

• Host: GitHub
• URL: https://github.com/coding-nerfilio/my-tiny-api
• Owner: coding-nerfilio
• Created: 2024-04-07T22:53:08.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-08T00:36:32.000Z (7 months ago)
• Last Synced: 2024-08-19T07:50:34.907Z (3 months ago)
• Topics: express, nodejs, rest-api, typeorm
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/my-tiny-api
• Size: 43 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# my-tiny-api

**my-tiny-api** is a Node.js package designed to scaffold a Express CRUD API REST for TypeORM entities with validation. Additionally, it automates the generation of a Postman collection for each endpoint, providing a seamless development experience for building APIs quickly and efficiently.

## Features

- Scaffold a CRUD API REST for TypeORM entities effortlessly (Create, Delete, Update, Get by id, Paginated Get).

- Automatically generate a Postman collection for each endpoint.

- Simplify API development and testing workflow.

## Installation

You can install **my-tiny-api** via npm:

```bash

npm install my-tiny-api

```

## Usage

To use **my-tiny-api**, follow these steps:

1. Install **my-tiny-api** as a development dependency in your Node.js project.

2. Create your TypeORM entities.

3. Import **my-tiny-api** into your project and initialize it

```bash

  app.use(

    MyTinyAPI({

      connection, //DataSource Typeorm

      entities: ["Posts","Comments"], //Typeorm entities

      config: {

        host: "localhost",

        port: 3000,

        basePath: "/api/",

        apiName: "BlogApi"

      },

    })

  );

```

4. Enjoy your scaffolded CRUD API REST and the automatically generated Postman collection!

![alt text](https://github.com/coding-nerfilio/my-tiny-api/blob/main/image.png?raw=true)

## Roadmap

Some functionality to add in the future:

- Authentication

- Customization for each endpoint

## Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

## License

This package is licensed under the MIT License.