ipenywisipenywis
117

Clean Rest Apis

screenshot of Clean Rest Apis
express
prisma

Best Practices to write clean RESTFUL APIs using Node.js and Express

Github

Overview:

This document provides an example of implementing a REST API with TypeScript using Express and Prisma Client. It includes steps to get started, create and seed the database, start the REST API server, and use the different endpoints to interact with the API.

Features:

  • REST API Implementation: Demonstrates how to implement a REST API using TypeScript, Express, and Prisma Client.
  • SQLite Database: Utilizes an SQLite database file with initial dummy data for demonstration purposes.
  • API Endpoints: Provides various endpoints for fetching posts, users, creating posts and users, updating post status, and deleting posts.
  • Database Migration with Prisma Migrate: Explains the process of migrating the database using Prisma Migrate and updating application code.

Summary:

This document serves as a guide for implementing a REST API with TypeScript using Express and Prisma Client. It covers the setup process, database creation, server startup, endpoint usage, and migrating the database for evolving the application. The example showcases the functionality of interacting with posts, users, creating content, and updating database schema for the application's future enhancements.

express
Express

Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.

prisma
Prisma

Prisma is a server-side library that helps developers read and write data to the database in an intuitive, efficient and safe way.

fullstack
Fullstack

A fullstack boilerplate provides a starter application that includes both frontend and backend. It should include database, auth, payments, user roles and other backend services to build a fully featured saas or webapps.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.