Skip to content

Commit

Permalink
Merge pull request #8 from apiaddicts/feature/md
Browse files Browse the repository at this point in the history 
up changes v2 md
  • Loading branch information
@admin-cloudappi
admin-cloudappi authored Sep 21, 2023
2 parents 141a31a + eb51b17 commit f60392e
Show file tree
Hide file tree
Showing 59 changed files with 2,076 additions and 1,808 deletions.
6 changes: 4 additions & 2 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
node_modules/*
.vscode/
package-lock.json
package.json
generated/
example/*.yaml
example/*.yml
Postman_files
694 changes: 693 additions & 1 deletion LICENSE
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/README_ES.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Openapi2postman
# swagger2postman

Openapi2postman genera una colección y un entorno Postman a partir de un archivo de definición OpenApi v. 2.0 (AKA swagger). Dicha colección incluye tests para respuestas 2xx, 400, 401 y 404.
swagger2postman genera una colección y un entorno Postman a partir de un archivo de definición OpenApi v. 2.0 (AKA swagger). Dicha colección incluye tests para respuestas 2xx, 400, 401 y 404.

![image1.png](images/image1.png)

Expand Down Expand Up @@ -42,7 +42,7 @@ También puede probarse enviando parámetros de tipo erróneo (distinto al defin
## Archivo de configuración

Es posible configurar la ejecución de la herramienta para que genere las colecciones y entornos que se deseen, eligiendo el nombre de los archivos, la ubicación dónde se dejarán los resultados, el tipo de peticiones que se pueden realizar, etc. Dicha configuración se establece de forma individualizada para cada colección y entorno. Puede consultarse la definición y ejemplos de dicho archivo de configuración en el siguiente documento:
[Archivo de configuración openapi2postman](./docs/openapi2postman-Archivo_de_configuracion.pdf)
[Archivo de configuración swagger2postman](./docs/MD-swagger2postman-Archivo_de_configuracion.pdf)

En la estructura de archivos se incluye un archivo de configuración que puede tomarse como ejemplo.

Expand Down
2 changes: 1 addition & 1 deletion docs/start_guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In all cases the status is checked and it is verified that the scheme of the out

![image2.png](images/image2.png)

Openapi2postman also generates a file of type environment with all the variables of both the bodies and the paths. These variables are used by the collection of postman generated to compose their bodies and their paths.
swagger2postman also generates a file of type environment with all the variables of both the bodies and the paths. These variables are used by the collection of postman generated to compose their bodies and their paths.

![image3.png](images/image3.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/startguide_ES.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Openapi2postman
# swagger2postman

Openapi2postman genera una colección y un entorno Postman a partir de un archivo de definición OpenApi v. 2.0 (AKA swagger). Dicha colección incluye tests para respuestas 2xx, 400, 401 y 404.
swagger2postman genera una colección y un entorno Postman a partir de un archivo de definición OpenApi v. 2.0 (AKA swagger). Dicha colección incluye tests para respuestas 2xx, 400, 401 y 404.

![image1.png](images/image1.png)

Expand Down Expand Up @@ -42,7 +42,7 @@ También puede probarse enviando parámetros de tipo erróneo (distinto al defin
## Archivo de configuración

Es posible configurar la ejecución de la herramienta para que genere las colecciones y entornos que se deseen, eligiendo el nombre de los archivos, la ubicación dónde se dejarán los resultados, el tipo de peticiones que se pueden realizar, etc. Dicha configuración se establece de forma individualizada para cada colección y entorno. Puede consultarse la definición y ejemplos de dicho archivo de configuración en el siguiente documento:
[Archivo de configuración openapi2postman](./docs/openapi2postman-Archivo_de_configuracion.pdf)
[Archivo de configuración swagger2postman](./docs/MD-swagger2postman-Archivo_de_configuracion.pdf)

En la estructura de archivos se incluye un archivo de configuración que puede tomarse como ejemplo.

Expand Down
Binary file added docs/swager2postman-Guía de usuario.pdf
View file
Binary file not shown.
Binary file added docs/swagger2postman-Archivo_de_configuracion.pdf
View file
Binary file not shown.
206 changes: 1 addition & 205 deletions example/SWAGGER_API_TestSuiteEnv_DEV.postman_environment.json
View file
Original file line number Diff line number Diff line change
@@ -1,205 +1 @@
{
"id": "10a413ae-b106-43fe-9cc5-8481250a4bfe",
"name": "SWAGGER_API_TestSuiteEnv_DEV",
"values": [
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.001.001.clubname",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.001.002.idClub",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.001.002.idRegion",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.002.001.Region",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.002.001.idRegion",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.002.002.Region",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.002.002.idRegion",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.002.004.idRegion",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.003.001.Team",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.001.idCategory",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.001.idClub",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.001.idRegion",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.001.idSeason",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.001.idTeam",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.002.idClub",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": 6,
"key": "TC.003.002.idTeam",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.004.001.idAwayTeam",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.004.001.idHomeTeam",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "goodstring",
"key": "TC.004.001.season",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "",
"key": "basePath",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": "petstore.swagger.io",
"key": "host",
"enabled": true
},
{
"description": {
"content": "",
"type": "text/plain"
},
"value": ":443",
"key": "port",
"enabled": true
}
],
"_postman_variable_scope": "environment"
}
{"id":"10a413ae-b106-43fe-9cc5-8481250a4bfe","name":"SWAGGER_API_TestSuiteEnv_DEV","values":[{"description":{"content":"","type":"text/plain"},"key":"basePath","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"petstore.swagger.io","key":"host","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_delete_petId_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_get_petId","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_get_petId_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_get_status","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_get_tags","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_post_petId","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_category_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_id","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_id_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_name","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_name_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_photoUrls","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_photoUrls_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_status","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_status_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"pet_put_tags_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":":443","key":"port","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_delete_orderId_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_get_orderId","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_get_orderId_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_complete","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_complete_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_id","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_id_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_petId","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_petId_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_quantity","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_quantity_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_shipDate","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_shipDate_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_status","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"store_post_status_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_delete_username_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_get_password","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_get_username","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_get_username_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_email","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_email_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_firstName","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_firstName_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_id","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_id_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_lastName","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_lastName_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_password","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_password_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_phone","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_phone_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_userStatus","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_userStatus_wrong","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_username","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_username_not_found","enabled":true},{"description":{"content":"","type":"text/plain"},"value":"","key":"user_put_username_wrong","enabled":true}],"_postman_variable_scope":"environment"}
Loading

0 comments on commit f60392e

Please sign in to comment.