Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create swagger interface between RS API and RS store #108

Open
benjefferies opened this issue Jan 27, 2020 · 0 comments
Open

Create swagger interface between RS API and RS store #108

benjefferies opened this issue Jan 27, 2020 · 0 comments
Labels
CDR

Comments

@benjefferies
Copy link
Contributor

Description

In order for the toolkit to enable banks to implement open banking standards, the RS API will need to be integrated with the banks RS store.

The banks RS APIs will not conform to the APIs the Toolkits RS API is expected to call, therefore the banks will need to implement a gateway which will be responsible for taking a validated request from the Toolkits RS API and calling the banks RS APIs to fetch or update resources.

We should adopt industry standards for defining said interfaces.

Acceptance criteria

  • Define an OpenAPI spec for the RS store
  • Regenerate RS store APIs from spec
  • Ensure existing functionality not broken
@benjefferies benjefferies added this to To do in OpenBankingToolkit via automation Jan 27, 2020
@benjefferies benjefferies mentioned this issue Jan 27, 2020
Closed
benjefferies added a commit that referenced this issue Jan 28, 2020
@benjefferies
Create OpenAPI specs of rs store
6048909 
Still work in progress but wanted to share initial workings with the
team. I reverse generated the swagger by enabling SpringFox swagger
endpoints and then refactoring the various endpoints into the different
specs. The specs need to live separately because the `swagger-codegen`
tool uses the first part of the path to decide which java files to
create, because the first path was `/openbanking` for all APIs it was
creating one massive file.

To tests run

```
forgerock-openbanking-uk-aspsp-rs/forgerock-openbanking-uk-aspsp-rs-mock-store/generate-bank-resource-server.sh spring spring-mvc --group-id com.forgerock.openbanking -DuseBeanValidation=true -DinterfaceOnly=true
```

See #108
for more information
@benjefferies benjefferies mentioned this issue Jan 28, 2020
Merged
benjefferies added a commit that referenced this issue Jan 30, 2020
@benjefferies
Create OpenAPI specs of rs store (#111)
4a9539a 
* Create OpenAPI specs of rs store

Still work in progress but wanted to share initial workings with the
team. I reverse generated the swagger by enabling SpringFox swagger
endpoints and then refactoring the various endpoints into the different
specs. The specs need to live separately because the `swagger-codegen`
tool uses the first part of the path to decide which java files to
create, because the first path was `/openbanking` for all APIs it was
creating one massive file.

To tests run

```
forgerock-openbanking-uk-aspsp-rs/forgerock-openbanking-uk-aspsp-rs-mock-store/generate-bank-resource-server.sh spring spring-mvc --group-id com.forgerock.openbanking -DuseBeanValidation=true -DinterfaceOnly=true
```

See #108
for more information
@BohoCode BohoCode removed this from To do in OpenBankingToolkit May 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CDR
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@benjefferies