webservice-foundation

Release 0.0.1.12

webservice 基盤

Homepage Repository PyPI

Install
pip install webservice-foundation==0.0.1.12

Documentation

webservice_foundation

OverView

(.yml|.yaml|.json)ファイルにルーティング情報を設定することで自動的に
HTTP サーバーが出来上がる。
Web サービスの基盤フレームワークはtornado==6.0.3を使用しているため、
関数をasync/awaitで記述することも可能

Argument

  • (-f|--file): web サービス設定ファイル(デフォルト:webservice.yaml)
  • (-p|--port): web サービスのポート番号(デフォルト:8080)

Example

key value required overview
services object ○ 公開するサービスを設定
  サービス名 object ○ サービス設定
    module str ○ インポートするモジュール指定
    endpoint str ○ 公開する URI
    events object ○ プロトコル設定
      http object ○ http 通信
        methods object ○ メソッド指定
environment object - 環境変数
app_setting object - Application へ渡す設定値

yaml ファイル

services:
  # 任意のサービス名
  hello:
    # 任意のフォルダ名.ファイル名
    # 実際のフォルダ構成は
    # ├─ tests/
    #     ├─ hello.py
    #     └─ test_dir/
    #         └─ test.py
    module: tests.hello
    # URLを記載する
    endpoint: /api/hello
    # 実行されるEventを記載する
    events:
      # 通信規格を指定
      # websocketも対応予定
      http:
        # HTTP Methodを記述していく
        # HTTP Method: 関数名
        methods:
          get: get_hello
          post: post_hello
  test:
    module: tests.test_dir.test
    endpoint: /api/test
    cls:
      handler: TestHandler

json ファイル

{
  "services": {
    "hello": {
      "module": "tests.hello",
      "endpoint": "/api/hello",
      "events": {
        "http": {
          "methods": {
            "get": "get_hello",
            "post": "post_hello"
          }
        }
      }
    },
    "test": {
      "module": "tests.test_dir.test",
      "endpoint": "/api/test",
      "cls": {
        "handler": "TestHandler"
      }
    }
  }
}

hello.py

# tests/hello.py
from baserequest import BaseRequestHandler


def get_hello(event: BaseRequestHandler):
    event.write('GET')


def post_hello(event: BaseRequestHandler):
    print(event.bodydata)

test.py

# tests/test_dir/test.py
from baserequest import BaseRequestHandler


def get_test(event: BaseRequestHandler):
    event.write('TEST GET')

Stats

Dependencies
2
Dependent packages
0
Dependent repositories
0
Total releases
16
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
6

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

1.0.0
0.0.1.13
0.0.1.12
0.0.1.11
0.0.1.10
0.0.1.9
0.0.1.8
0.0.1.7
0.0.1.6
0.0.1.5
See all 16 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2021-02-23 11:35:22 UTC

Login to resync this project