8000 GitHub - kibitan/contract_management_api: API server for contract management
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

kibitan/contract_management_api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contract Management API

API server for contract management.

Installation

 $ git clone git@github.com:kibitan/contract_management_api.git
 $ bin/setup

Requirement

  • Ruby 2.5.0
  • PostgreSQL

API documentation

Defined with OpenAPI Specification ver. 2 (fka Swagger) at swagger.yml

You can see documentation as Swagger UI by

 $ docker pull swaggerapi/swagger-ui
 $ docker run -p 80:8080 -e API_URL=http://localhost:3000/v1/swagger.json swaggerapi/swagger-ui
 // with Docker for Mac with higher than v 17.06, use API_URL=http://docker.for.mac.localhost:3000/v1/swagger.json
 $ open http://localhost

Usage

NOTE: now development only

 $ bundle exec rails s

Run test

 $ bundle exec rspec

TODO

  • update swagger.yaml
  • implement error handing for /v1/uesrs
    • use comittee
      • it's not working well with OpenAPI v2
  • implement authorization
    • implement ApiKeyAuth
    • implement BasicAuth
  • implement contracts API
    • /contracts post
    • /contracts/{contract_id} get
    • /contracts/{contract_id} delete
    • introduce jb or json-api for building json response

About

API server for contract management

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0