Skip to main content

Apiruns CLI is a tool to make self-configurable rest API.

Project description

apiruns-cli

Apiruns CLI is a tool to make self-configurable rest API. Create an API rest has never been so easy.

Requirements

  • Python 3.6+

Installation.

pip install apiruns
poetry install

Example

apiruns --help

 Usage: apiruns [OPTIONS] COMMAND [ARGS]...
 
╭─ Options───────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ build                       Build images & validate schema.🔧              │
│ down                        Stops containers and removes containers. 🌪    │
│ up                          Make your API rest. 🚀                         │
│ version                     Get current version. 💬                        │
╰────────────────────────────────────────────────────────────────────────────╯

file configuration

Make YAML file to configure your application’s services. api.yml

# This is an example manifest to create microservices in apiruns.

myapi: # Microservices name.

  # first endpoint
  - path: /users/ # Path name.
    schema: # Schema of data structure.
      username:
        type: string
        required: true
      age:
        type: integer
        required: true
      is_admin:
        type: boolean
        required: true
      level:
        type: string

Crear a API Rest

apiruns up --file examples/api.yml 

Building API
Creating DB container.
Creating API container.
Starting services
API listen on 8000

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiruns-0.0.5.tar.gz (8.4 kB view hashes)

Uploaded Source

Built Distribution

apiruns-0.0.5-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page