Просмотр исходного кода

Update README with accurate examples

Andrew Swistak 6 лет назад
Родитель
Сommit
75d8afca41
1 измененных файлов с 14 добавлено и 6 удалено
  1. 14 6
      README.md

+ 14 - 6
README.md

@@ -7,11 +7,17 @@
 
 ##### `POST /parse`
 
-Query Params:
+Query Params as multipart form:
 
-| Param | Required | Description                                     |
-| ---   | ---      | ---                                             |
-| pkmn  | ✔️        | One more pk7 files uploaded in a multipart form |
+| Param   | Required | Description                                                                      |
+| ---     | ---      | ---                                                                              |
+| pokemon | ✔️        | One or more pk7 files uploaded in a multipart form and/or base64 encoded strings |
+
+Query Params as JSON:
+
+| Param   | Required | Description                            |
+| ---     | ---      | ---                                    |
+| pokemon | ✔️        | JSON array of base64 encoded pk7 files |
 
 Response:
 
@@ -24,7 +30,9 @@ Response:
 
 Sample request and response:
 
-`curl -X POST http://localhost:8080/parse -F "pkmn=/path/to/thefile.pk7" -F "pkmn=/path/to/anotherfile.pk7" -H "Content-Type: multipart/form-data"`:
+`curl -X POST http://localhost:8080/parse -F "pokemon=/path/to/thefile.pk7" -F "pokemon=wJsMkgAAN4IZAAAA0qVgJQAAAAAJAQAA7DtV5QAJAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAFAAaQBrAGEAYwBoAHUAAAAAAAAAAAAAAAAA8QFVABgB5wAPDw8PAAAAAFUAYgBXAGEAAAAWYq41UABQAG8AcgBnAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAARgAAAAAAAAAAAAAAAABBAHMAaAAAAAAAAAAAAAAAAAAAAAAAAAAAAEYAAAAAAAAAAAARChAAAABBnAQBAB9OAAICAAAAAA==" -H "Content-Type: multipart/form-data"`:
+**or**
+`curl -X POST http://localhost:8080/parse -H "Content-Type: application/json" -d '{"pokemon":["ewMXgQAA3QEUAAAAbaoyREAfAAAvBAAAQ1aIAxISAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFIAYQB0AGkAYwBhAHQAZQAAAAAAAAAAAAAApAB1AVMBngAKDxQPAAAAAAAAAAAAAAAAAAA8/P8XUABQAG8AcgBnAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAARgAAAAAAAAAAAAAAAABQAFAAbwByAGcAAAAAAAAAAAAAAAAAAAAAAEYAAAAAAAAAAAARCxIAAADKAAQUACEBAgACAAAAAA==","wJsMkgAAN4IZAAAA0qVgJQAAAAAJAQAA7DtV5QAJAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAFAAaQBrAGEAYwBoAHUAAAAAAAAAAAAAAAAA8QFVABgB5wAPDw8PAAAAAFUAYgBXAGEAAAAWYq41UABQAG8AcgBnAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAARgAAAAAAAAAAAAAAAABBAHMAaAAAAAAAAAAAAAAAAAAAAAAAAAAAAEYAAAAAAAAAAAARChAAAABBnAQBAB9OAAICAAAAAA=="]}'`:
 ```
 {
    [
@@ -51,7 +59,7 @@ Sample error response:
 | error | description of the error |
 
 Example error:
-`curl -X POST http://localhost:8080/parse -F "pkmn=/path/to/an/invalidfile.pk7" -H "Content-Type: multipart/form-data"`:
+`curl -X POST http://localhost:8080/parse -F "pokemon=/path/to/an/invalidfile.pk7" -H "Content-Type: multipart/form-data"`:
 ```
 {
   "error": "Invalid length for generation 7 pokemon: 229 bytes"