Skip to content

Commit bab9fc3

Browse files
committed
update sample
1 parent 67ab6aa commit bab9fc3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

SummerRestSample/Assets/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ To use the generated requests, there are some notable folders under the Asset fo
66
- [Configures/SummerRest](Assets/Configures/SummerRest): Contains the necessary items for the plugin. Please do not modify them manually
77
- [Scripts/Model](Assets/Scripts/Model): Request and response data containers. Because of using [Unity Serialization](https://docs.unity3d.com/Manual/script-Serialization.html), please remember to use `System.Serializable` attribute (and [SerializeField](https://docs.unity3d.com/ScriptReference/SerializeField.html) with private fields)
88
- [Scripts/Customs](Assets/Scripts/Customs): Classes under this folder demonstrate how to embed your implementations into the working flow of the plugin.
9-
- Here we create 2 customized classes [LogDataSerializer](Assets/Scripts/Customs/LogDataSerializer.cs) and [LogSecretRepository](Assets/Scripts/Customs/LogSecretRepository.cs) to log operations before sending them to the default implementations
9+
- Here we create 2 custom classes [LogDataSerializer](Assets/Scripts/Customs/LogDataSerializer.cs) and [LogSecretRepository](Assets/Scripts/Customs/LogSecretRepository.cs) to log operations before sending them to the default implementations
1010
- In the plugin window, we select the classes in the `Advanced settings` section
1111
- [Scripts/Auth](Assets/Scripts/Auth): Shows how to implement a custom auth appender
12-
- We create a customized class [DummyJsonApiAuthAppender](Assets/Scripts/Auth/DummyJsonApiAuthAppender.cs) appending a header pair `Authorization:<access-token>`
12+
- We create a custom class [DummyJsonApiAuthAppender](Assets/Scripts/Auth/DummyJsonApiAuthAppender.cs) appending a header pair `Authorization:<access-token>`
1313
- Create a respective auth container with appender type is the class we've just created
14-
- In the `GetUser` request, we points the auth container
14+
- In the `GetUser` request, we point to the auth container
1515
- [Scripts/Managers](Assets/Scripts/Managers)
1616
1. [SampleCoroutineManager](Scripts/Managers/SampleCoroutineManager.cs) shows how to call HTTP endpoints by leveraging `Coroutine` system
1717
2. [SampleTaskManager](Scripts/Managers/SampleTaskManager.cs) shows how to call HTTP endpoints asynchronously by using [UniTask](https://github.com/Cysharp/UniTask). To enable the code belonging to this section, you need to
1818
1. Import [UniTask](https://github.com/Cysharp/UniTask) package
1919
2. Add **SUMMER_REST_TASK** [Scripting Define Symbol](https://docs.unity3d.com/Manual/CustomScriptingSymbols.html) (briefly, you may find it at `Player settings` > `Other settings` > `Script compilation`)
2020
![](../../Screenshots/3_source_2_symbol.png)
21-
3. In the end part of the manager classes, you will figure out to call independent requests which are not configured in the window
21+
3. At the end of the manager classes, you will figure out to call independent requests which are not configured in the window
2222

2323
[summer-rest-generated.RestSourceGenerator](Configures/summer-rest-generated.RestSourceGenerator.additionalfile) is an additional file for generating code, please click on `Generate source to` button to refresh the file and its associated source everytime you want to sync the plugin configures with your project

0 commit comments

Comments
 (0)