README.md in fitting-2.18.3 vs README.md in fitting-3.0.0
- old
+ new
@@ -46,20 +46,24 @@
Also Swagger
```yaml
prefixes:
- name: /api/v1
- openapi2_json_path: doc.json
+ type: openapi2
+ schema_paths:
+ - doc.json
```
### OpenAPI 3.0
Also OpenAPI
```yaml
prefixes:
- name: /api/v1
- openapi3_yaml_path: doc.yaml
+ type: openapi3
+ schema_paths:
+ - doc.yaml
```
### API Blueprint
First you need to install [drafter](https://github.com/apiaryio/drafter).
Works after conversion from API Blueprint to API Elements (in YAML file) with Drafter.
@@ -73,21 +77,25 @@
and then
```yaml
prefixes:
- name: /api/v1
- drafter_yaml_path: doc.yaml
+ type: drafter
+ schema_paths:
+ - doc.yaml
```
### Tomograph
To use additional features of the pre-converted [tomograph](https://github.com/funbox/tomograph)
```yaml
prefixes:
- name: /api/v1
- tomogram_json_path: doc.json
+ type: tomogram
+ schema_paths:
+ - doc.json
```
## Run
Run tests first to get run artifacts
```bash
@@ -97,10 +105,15 @@
and then
```bash
bundle e rake fitting:report
```
+Run tests by outgoing request first to get run artifacts
+```bash
+bundle e rake fitting_out:report
+```
+
Console ouptut
```text
/api/v1
POST /api/v1/accounts/{account_id}/inboxes 0% 200 0% 404 0% 403
@@ -142,21 +155,48 @@
Setting the prefix name is optional. For example, you can do this:
```yaml
prefixes:
- - openapi2_json_path: doc.json
+ - type: openapi2
+ schema_paths:
+ - doc.json
```
## prefix skip
It is not necessary to immediately describe each prefix in detail, you can only specify its name and skip it until you are ready to documented it
```yaml
prefixes:
- name: /api/v1
- openapi2_json_path: doc.json
+ type: openapi2
+ schema_paths:
+ - doc.json
- name: /api/v3
skip: true
+```
+
+For work with WebMock outgoing request, you should set up outgoing prefixes
+```yaml
+outgoing_prefixes:
+- name: /api/v1
+ type: openapi2
+ schema_paths:
+ - doc.json
+- name: /api/v3
+ skip: true
+```
+
+You can choose location that must be teste
+
+```yaml
+prefixes:
+ - type: openapi2
+ schema_paths:
+ - doc.json
+ only:
+ - POST /api/v1/users
+ - GET /api/v1/user/{id}
```
## Contributing
Bug reports and pull requests are welcome on GitHub at [github.com/funbox/fitting](https://github.com/funbox/fitting).