Skip to content

yamachig/elaws-openapi-proxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

elaws-openapi-proxy

An OpenAPI proxy server for e-LAWS API (the official API for Japanese laws data).

How to use

Option 1: Run locally

  1. Prerequisites: Node.js
  2. In the ./server directory, run the following commands:
    • npm install
    • npm start
  3. Then access http://localhost:3000/docs to open Swagger UI. You can obtain the OpenAPI spec at http://localhost:3000/openapi.json .

Option 2: Deploy on AWS

Be aware that this option creates resources on AWS and may incur costs.

  1. Prerequisites: Node.js, AWS CDK CLI, Active AWS account, and Docker.
  2. In the ./cdk directory, run the following commands:
    • npm install
    • npm run deploy
  3. Then access [ApiEndpoint]/docs to open Swagger UI. You can obtain the OpenAPI spec at [ApiEndpoint]/openapi.json .

Examples

See the examples directory for examples.

About

An OpenAPI proxy for e-LAWS API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published