artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 15:56:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

tweaking

Browse Source
This commit is contained in:
hongwei 2019-01-17 13:21:09 +01:00
parent 0e801e2e96
commit ddf19a6a05
2 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.md
View File

@ -55,6 +55,33 @@ class FundsAvailableTest extends V310ServerSetup {
}
```
## Code Generation
We support to generate the OBP-API code from the following three types of json. You can choose one of them as your own requirements.
1 Choose one of the following types: type1 or type2 or type3
2 Modify the json file your selected,
3 Run the Main method according to your json file
4 Run/Restart OBP-API project.
5 Run API_Exploer project to test your new APIs. (click the Tag `APIBuilder B1)
Here are the three types:
Type1: If you use `modelSource.json`, please run `APIBuilderModel.scala` main method
```
OBP-API/src/main/scala/code/api/APIBuilder/APIModelSource.json
OBP-API/src/main/scala/code/api/APIBuilder/APIBuilderModel.scala
```
Type2: If you use `apisResource.json`, please run `APIBuilder.scala` main method
```
OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/apisResource.json
OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/APIBuilder.scala
```
Type3: If you use `swaggerResource.json`, please run `APIBuilderSwagger.scala` main method
```
OBP-API/src/main/scala/code/api/APIBuilder/swagger/swaggerResource.json
OBP-API/src/main/scala/code/api/APIBuilder/swagger/APIBuilderSwagger.scala
```
## Issues
If would like to report an issue or suggest any kind of improvement please use Github Issues.

26
README.md
View File

@ -452,31 +452,7 @@ You can obfuscate passwords in the props file the same way as for jetty:
* db.url=OBF:fdsafdsakwaetcetcetc
## Code Generation
We support to generate the OBP-API code from the following three types of json. You can choose one of them as your own requirements.
1 Choose one of the following types: type1 or type2 or type3
2 Modify the json file your selected,
3 Run the Main method according to your json file
4 Run/Restart OBP-API project.
5 Run API_Exploer project to test your new APIs. (click the Tag `APIBuilder B1)
Here are the three types:
Type1: If you use `modelSource.json`, please run `APIBuilderModel.scala` main method
```
OBP-API/src/main/scala/code/api/APIBuilder/APIModelSource.json
OBP-API/src/main/scala/code/api/APIBuilder/APIBuilderModel.scala
```
Type2: If you use `apisResource.json`, please run `APIBuilder.scala` main method
```
OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/apisResource.json
OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/APIBuilder.scala
```
Type3: If you use `swaggerResource.json`, please run `APIBuilderSwagger.scala` main method
```
OBP-API/src/main/scala/code/api/APIBuilder/swagger/swaggerResource.json
OBP-API/src/main/scala/code/api/APIBuilder/swagger/APIBuilderSwagger.scala
```
Please refer to the [Code Generation](https://github.com/OpenBankProject/OBP-API/blob/develop/CONTRIBUTING.md##code-generation) for links
## Using jetty password obfuscation with props file