Skip to main content

A tool to generate a mock server from yaml file using python

Project description

forthebadge made-with-python
PyPI license PyPI pyversions Build Status Documentation Status image
Note:This is still in development stage, and will probably have bugs in it, feel free to raise an issue for the same

pysmock

Python module to generate mock server from yaml file
Documentation
Usage: python3 -m pysmock --input input_data.yaml --output app/

Sample YAML File

info:
  name: "Test APIs"
  description: "description of your API"
  version: "v1"
  title: "Mock APIs"
host: "localhost:8080"
basePath: "/mock"
apiRequests:
 - get:
      request:
      response:
        json:
          resourceId: 1
          type: ResourceInfo
        status_code: 200
      url: resource/1
 - post:
      request:
        body:
            name: "[A-Za-z0-9 ]*"
            data: Some data for resource
        headers:
          content-type: application/json
      response:
        json:
          resourceId: 1
          type: ResourceInfo
          name: $request.body.name
          data: $request.body.data
        status_code: 200
      url: resource

REST Endpoints

  • Server Info:
    GET /base_url+"/info"
{
    "contact": null,
    "description": "description of your API",
    "license": null,
    "name": "Test APIs",
    "termsOfService": "",
    "title": "Mock APIs",
    "version": "v1"
}
  • API 1
    GET /base_url+"/resource/1"
{
    "resourceId": 1,
    "type": "ResourceInfo"
}
  • API 2
    POST /base_url+"/resource"
    Request:
{
    "name": "My new Resource1",
    "data": "Some data for resource"
}

Response

{
    "data": "Some data for resource",
    "name": "My new Resource1",
    "resourceId": 1,
    "type": "ResourceInfo"
}

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pysmock-0.1.4-py3-none-any.whl (15.1 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