Code Monkey home page Code Monkey logo

todo-list-rest's Introduction

待辦事項REST APIs

  • gin
  • GORM 2.0
  • middleware
    • 自訂log記錄資訊
    • 統一逾時控制
    • JWT
    • API限流
    • Jaeger 鏈路追蹤
  • viper config管理
  • docker
    • 部署 Jaeger
    • 部署 MySql

API

取得交易權杖

回傳JWT取得在權杖有效期限內進行其他API存取的權限,此功能使用github.com/juju/ratelimi提供的token bucket實作來實現api限流控管

GET /auth/{appKey}/{appSecret}

  • Path params
    • appKey: 每次交易前用來獲取權杖
    • appSecret: 同上

查詢待辦事項清單

GET /api/v1/{createdBy}/{state}/todos?page={int}&pageSize={int}

  • Headers
    • token: 傳入/auth 所取得的JWT
  • Path params
    • createdBy: 待辦事項建立的人
    • state: 0: 待處理、 1: 已完成
  • Query params
    • page: 分頁第幾頁
    • pageSize: 每頁最大筆數

建立待辦事項

POST /api/v1/todo

  • Headers
    • token: 傳入/auth 所取得的JWT
    • Content-Type: multipart/form-data
  • Body params
    • item: 待辦事項內容
    • createdBy: 待辦事項建立的人

刪除待辦事項

DELETE /api/v1/todo/{id}

  • Headers
    • token: 傳入/auth 所取得的JWT
  • Path params
    • id: 待辦事項的id

更新待辦事項

PUT /api/v1/todo/{id}

  • Headers
    • token: 傳入/auth 所取得的JWT
    • Content-Type: multipart/form-data
  • Path params
    • id: 待辦事項的id
  • Body params
    • item: 待辦事項內容

更新待辦事項狀態

PATCH /api/v1/todo/{id}

  • Headers
    • token: 傳入/auth 所取得的JWT
    • Content-Type: multipart/form-data
  • Path params
    • id: 待辦事項的id
  • Body params
    • state: 0: 待處理、 1: 已完成

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.