معرفی شرکت ها
bddrest-4.2.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A toolchain for testing REST APIs in BDD manner.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | bddrest-4.2.0 |
| نام | bddrest |
| نسخه کتابخانه | 4.2.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Vahid Mardani |
| ایمیل نویسنده | vahid.mardani@gmail.com |
| آدرس صفحه اصلی | https://github.com/pylover/bddrest |
| آدرس اینترنتی | https://pypi.org/project/bddrest/ |
| مجوز | MIT |
# bddrest
Toolchain to define and verify REST API in BDD.
[](https://pypi.python.org/pypi/bddrest)
[](https://github.com/pylover/bddrest/actions/workflows/build.yml)
[](https://coveralls.io/github/pylover/bddrest?branch=master)
Table of Contents
=================
* [Quick start](#quick-start)
* [Writing tests](#writing-tests)
* [Dumping a Story](#dumping-a-story)
* [Auto Dumping](#auto-dumping)
* [Markdown](#markdown)
* [Command Line Interface](#command-line-interface)
* [Enabling the bash autocompletion for bddrest](#enabling-the-bash-autocompletion-for-bddrest)
## Quick start
### Writing tests
Using `Given`, `when`, functions as you see in the example below, you can
determine and assert the behaviour of your `REST API`.
The `story`, `response`, `status` objects are some proxies for currently
writing story(*inside the with Given( ... ): context*) and it's response.
and the last response after a `Given` and or `when`.
```python
import re
import sys
import json
from bddrest.authoring import Given, when, response, status
def wsgi_application(environ, start_response):
path = environ['PATH_INFO']
if path.endswith('/None'):
start_response(
'404 Not Found',
[('Content-Type', 'text/plain;charset=utf-8')]
)
yield b''
else:
start_response(
'200 OK',
[('Content-Type', 'application/json;charset=utf-8')]
)
result = json.dumps(dict(
foo='bar'
))
yield result.encode()
with Given(
wsgi_application,
title='Quickstart!',
url='/books/id: 1',
as_='visitor') as story:
assert status == 200
assert status == '200 OK'
assert 'foo' in response.json
assert response.json['foo'] == 'bar'
when(
'Trying invalid book id',
url_parameters={'id': None}
)
assert response.status == 404
```
### Dumping a `Story`
```python
story.dumps()
```
Produces:
```yaml
base_call:
as_: visitor
description: As a member I have to POST a book to the library.
form:
name: BDD Book
query:
a: b
response:
headers:
- 'Content-Type: application/json;charset=utf-8'
json:
foo: bar
status: 200 OK
title: Posting a book
url: /books/:id
url_parameters:
id: '1'
verb: GET
calls:
- response:
headers:
- 'Content-Type: text/plain;charset=utf-8'
status: 404 Not Found
title: Trying invalid book id
url_parameters:
id: None
```
You may load the story again from this yaml with `Story.loads(yaml)`.
There are two additional methods available to dump and load to
and from a file: `story.load(file)` and `story.dump(file)`
#### Auto Dumping
You may pass the `autodump` argument of the `Given` function to configure the
auto-dumping:
:param autodump: A file-like object to write dumped story.
Default is `None`, means autodump is disabled by default.
#### Auto Documentation
You may pass the `autodoc` argument of the `Given` function to configure the
auto-documentation:
:param autodoc: A file-like object to write documentation.
Default is `None`, meana autodoc is disabled by default.
:param autodoc_format: Either ``markdown`` or ``html``. default is
``markdown``.
### Markdown
You can use `story.document([formatter_factory=MarkdownFormatter])` to generate documentation
in arbitrary format for example: `Markdown`.
There is also a CLI to do this:
```bash
bddrest document < story.yml > story.md
```
## Posting a book
### GET /books/:id
As a member I have to POST a book to the library.
### Url Parameters
Name | Example
--- | ---
id | 1
### Query Strings
Name | Example
--- | ---
a | b
### Form
Name | Example
--- | ---
name | BDD Book
### Response: 200 OK
#### Headers
* Content-Type: application/json;charset=utf-8
#### Body
```json
{"foo": "bar"}
```
## WHEN: Trying invalid book id
### Url Parameters
Name | Example
--- | ---
id | None
### Response: 404 Not Found
#### Headers
* Content-Type: text/plain;charset=utf-8
## Command Line Interface
After installing the project a command named `bddrest` will be available.
```bash
bddrest -h
```
### Enabling the bash autocompletion for bddrest
Add this into your `.bashrc` and or `$VIRTUAL_ENV/bin/postactivate`.
```bash
eval "$(register-python-argcomplete bddrest)"
```
### Mockup server
When you want serve the server for special yaml file using like below.
```bash
bddrest mockupserver yamlfilename
```
نحوه نصب
نصب پکیج whl bddrest-4.2.0:
pip install bddrest-4.2.0.whl
نصب پکیج tar.gz bddrest-4.2.0:
pip install bddrest-4.2.0.tar.gz