Git Product home page Git Product logo

book-api's Introduction

๐Ÿ“š Books REST API

ASP.NET Core PostgreSQL Dapper ORM
xUnit FluentAssertions NSubstitute

A simple REST API, following repository pattern for a books table.


๐Ÿ“„ API Specs

GET

HTTP Method Use Endpoint
GET Index all books /books
GET Show book by id /books/{id}
GET Index books by title or author /books?search=foo
GET Index books with custom limit /books?limit=5
GET Paginate books /books?limit=5&page=3
POST Create new book /books
PUT Update book /books/{id}
DELETE Destroy book /books/{id}

โš™๏ธ Setting Up

Local ๐Ÿ’ป

Prerequisites:

  • .NET 5.0
  • PostgreSQL

Running the api locally

  1. Copy and set up enviroment variables for the database

    cp .env.example .env
  2. Run the app on your local port

    dotnet watch run --project ./src/BookApi.csproj

Running the tests

  1. Run the tests

    cd tests
    dotnet test

Docker ๐Ÿณ

Prerequisites:

  • Docker

Running the containers

  1. Copy environment variables for the database

    cp .env.example .env
  2. Build docker images

    docker compose build
  3. Run docker containers

    docker compose up

Running the tests

  1. Run the tests in the api container

    docker compose exec api /bin/sh -c "cd tests; dotnet test;"

book-api's People

Contributors

lucaxue avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.