diff --git a/ParadoxSaveParser.WebAPI/README.md b/ParadoxSaveParser.WebAPI/README.md new file mode 100644 index 0000000..5daa402 --- /dev/null +++ b/ParadoxSaveParser.WebAPI/README.md @@ -0,0 +1,39 @@ +# WebAPI +Simple web application created using DTLib.Web. + +# Routes + +### POST `/uploadSave/eu4` +- **Request:** `application/octet-stream` - .eu4 file +- **Response:** + ```json + { "saveId": "string" } + ``` + or `{ "errorMessage": "string" }` + +### GET `/getSaveStatus` +- **Query Params:** + - `id` - id of uploaded save file +- **Response:** [SaveFileMetadata](./SaveFileMetadata.cs) + ```json + { + "id": "string", + "game": "string", + "status": "string", + "errorMessage": "string?" + } + ``` + +### GET `/getSaveData` +- **Query Params:** + - `id` - id of uploaded save file +- **Response:** + ```json5 + { + "key0": [ "objects" ], + "key1": [ "objects" ], + //... + } + ``` + or `{ "errorMessage": "string" }` +