- Adopted from: https://stubby4j.com/docs/admin_portal.html
- Inspired by Swagger API docs style & structure: https://petstore.swagger.io/#/pet
POST
/
(overwrites all in-memory stub and/or proxy-config)
name type data type description None required object (JSON or YAML) N/A
http code content-type response 201
text/plain;charset=UTF-8
Configuration created successfully
400
application/json
{"code":"400","message":"Bad Request"}
405
text/html;charset=utf-8
None
curl -X POST -H "Content-Type: application/json" --data @post.json http://localhost:8889/
GET
/
(gets all in-memory stub & proxy configs)
None
http code content-type response 200
text/plain;charset=UTF-8
YAML string
curl -X GET -H "Content-Type: application/json" http://localhost:8889/
GET
/{stub_numeric_id}
(gets stub by its resource-id-{stub_numeric_id} in the YAML config)
name type data type description stub_numeric_id
required int ($int64) The specific stub numeric id
http code content-type response 200
text/plain;charset=UTF-8
YAML string 400
application/json
{"code":"400","message":"Bad Request"}
curl -X GET -H "Content-Type: application/json" http://localhost:8889/0
GET
/{uuid}
(gets stub by its defined uuid property)
name type data type description uuid
required string The specific stub unique idendifier
http code content-type response 200
text/plain;charset=UTF-8
YAML string 400
application/json
{"code":"400","message":"Bad Request"}
curl -X GET -H "Content-Type: application/json" http://localhost:8889/some-unique-uuid-string
GET
/proxy-config/default
(gets default proxy-config)
None
http code content-type response 200
text/plain;charset=UTF-8
YAML string 400
application/json
{"code":"400","message":"Bad Request"}
curl -X GET -H "Content-Type: application/json" http://localhost:8889/proxy-config/default
GET
/proxy-config/{uuid}
(gets proxy config by its uuid property)
name type data type description uuid
required string The specific proxy config unique idendifier
http code content-type response 200
text/plain;charset=UTF-8
YAML string 400
application/json
{"code":"400","message":"Bad Request"}
curl -X GET -H "Content-Type: application/json" http://localhost:8889/proxy-config/some-unique-uuid-string
PUT
/{stub_numeric_id}
(updates stub by its resource-id-{stub_numeric_id} in the config)
name type data type description stub_numeric_id
required int ($int64) The specific stub numeric id
http code content-type response 201
text/plain;charset=UTF-8
Stub request index#<stub_numeric_id> updated successfully"
400
application/json
{"code":"400","message":"Bad Request"}
405
text/html;charset=utf-8
None
curl -X PUT -H "Content-Type: application/json" --data @put.json http://localhost:8889/0
PUT
/{uuid}
(updates stub by its defined uuid property)
name type data type description uuid
required string The specific stub unique idendifier
http code content-type response 201
text/plain;charset=UTF-8
Stub request uuid#<uuid> updated successfully
400
application/json
{"code":"400","message":"Bad Request"}
405
text/html;charset=utf-8
None
curl -X PUT -H "Content-Type: application/json" --data @put.json http://localhost:8889/some-unique-uuid-string
PUT
/proxy-config/default
(updates default proxy-config)
None
http code content-type response 201
text/plain;charset=UTF-8
Proxy config uuid#default updated successfully
400
application/json
{"code":"400","message":"Bad Request"}
405
text/html;charset=utf-8
None
curl -X PUT -H "Content-Type: application/json" --data @put.json http://localhost:8889/proxy-config/default
PUT
/proxy-config/{uuid}
(updates proxy-config by its uuid property)
name type data type description uuid
required string The specific proxy config unique idendifier
http code content-type response 201
text/plain;charset=UTF-8
Proxy config uuid#<uuid> updated successfully
400
application/json
{"code":"400","message":"Bad Request"}
405
text/html;charset=utf-8
None
curl -X PUT -H "Content-Type: application/json" --data @put.json http://localhost:8889/proxy-config/some-unique-uuid-string
DELETE
/
(deletes all in-memory stub & proxy configs)
None
http code content-type response 200
text/plain;charset=UTF-8
All in-memory YAML config was deleted successfully
curl -X DELETE -H "Content-Type: application/json" http://localhost:8889/
DELETE
/{stub_numeric_id}
(deletes stub by its resource-id-{stub_numeric_id} in the config)
name type data type description stub_numeric_id
required int ($int64) The specific stub numeric id
http code content-type response 200
text/plain;charset=UTF-8
Stub request index#<stub_numeric_id> deleted successfully
400
application/json
{"code":"400","message":"Bad Request"}
curl -X DELETE -H "Content-Type: application/json" http://localhost:8889/0
DELETE
/{uuid}
(updates stub by its defined uuid property)
name type data type description uuid
required string The specific stub unique idendifier
http code content-type response 200
text/plain;charset=UTF-8
Stub request uuid#<uuid> deleted successfully
400
application/json
{"code":"400","message":"Bad Request"}
curl -X DELETE -H "Content-Type: application/json" http://localhost:8889/some-unique-uuid-string
DELETE
/proxy-config/{uuid}
(deletes proxy-config by its uuid property)
name type data type description uuid
required string The specific proxy config unique idendifier
http code content-type response 200
text/plain;charset=UTF-8
Proxy config uuid#<uuid> deleted successfully
400
application/json
{"code":"400","message":"Bad Request"}
curl -X DELETE -H "Content-Type: application/json" http://localhost:8889/proxy-config/some-unique-uuid-string