Skip to content

Commit 4d1f353

Browse files
committed
api builder for swagger -- in process --update the README
1 parent 42daf1a commit 4d1f353

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -452,25 +452,30 @@ You can obfuscate passwords in the props file the same way as for jetty:
452452
* db.url=OBF:fdsafdsakwaetcetcetc
453453

454454
## Code Generation
455-
We support to generate the OBP-API code from the following two types of json. You can choose one of them as your own requirements.
455+
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.
456456

457-
1 Choose one of the following types: type1 or type2
457+
1 Choose one of the following types: type1 or type2 or type3
458458
2 Modify the json file your selected,
459459
3 Run the Main method according to your json file
460460
4 Run/Restart OBP-API project.
461461
5 Run API_Exploer project to test your new APIs. (click the Tag `APIBuilder B1)
462462

463-
Here are the two types:
463+
Here are the three types:
464464

465465
Type1: If you use `modelSource.json`, please run `APIBuilderModel.scala` main method
466466
```
467-
OBP-API/src/main/scala/code/api/APIBuilder/modelSource.json
467+
OBP-API/src/main/scala/code/api/APIBuilder/APIModelSource.json
468468
OBP-API/src/main/scala/code/api/APIBuilder/APIBuilderModel.scala
469469
```
470470
Type2: If you use `apisResource.json`, please run `APIBuilder.scala` main method
471471
```
472-
OBP-API/src/main/scala/code/api/APIBuilder/apisResource.json
473-
OBP-API/src/main/scala/code/api/APIBuilder/APIBuilder.scala
472+
OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/apisResource.json
473+
OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/APIBuilder.scala
474+
```
475+
Type3: If you use `swaggerResource.json`, please run `APIBuilderSwagger.scala` main method
476+
```
477+
OBP-API/src/main/scala/code/api/APIBuilder/swagger/swaggerResource.json
478+
OBP-API/src/main/scala/code/api/APIBuilder/swagger/APIBuilderSwagger.scala
474479
```
475480

476481
## Using jetty password obfuscation with props file

0 commit comments

Comments
 (0)