Giter VIP home page Giter VIP logo

sqlboiler-restapi-example's Introduction

sqlboiler-restapi-example

An boielrplate of REST API server using following tools.

This repository is an addendum of this post.

https://future-architect.github.io/articles/20210730a/

Prerequisites

  • air: Run the server with hot reloading.
  • PostgreSQL server

If you are opening this project via VSCode Remote Container, these tools are already configured in docker-compose.yml

Development

Project structure

.
├── boiler          # Generated codes by SQLBoiler
├── restapi         # Generated codes by oapi-codegen
├── sql             # Database table definitions
├── openapi.yml     # REST API definitions
├── cmd
│   └── server      # Run server
├── app.go          # Server implementation
├── db.go           # Database configurations
├── middleware.go   # net/http middlewares
├── event.go        # Select/Insert data from/to the database with types defined in REST API specs.
└── user.go

Generate code

Regenerate code when you modify following codes.

  • sql/*.sql: Database table definitions.
  • openapi.yml: API definitions.
make clean
make generate
go mod tidy

Run local server

air

App Configurations

Environment variables

  • DB_URL: Database URL. Defaults connect to the container running in Remote Container service.

sqlboiler-restapi-example's People

Contributors

uhey22e 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.