nstarlike / javamydata Goto Github PK

The auth project is to authenticate and authorize clients which want to be provided the services from the backend. This project uses the OAuth2 authorization framework with Spring Authorization Server.

The following is the list you should follow to build a skeleton in order.

• Add the Spring Authorization Server dependency.
• Configure the server in the application.yml file for the OAuth2.
• Define required components which are
  SecurityFilterChain,
  UserDetailsService,
  RegisteredClientRepository,
  JWKSource,
  JwtDecoder,
  AuthorizationServerSettings.

And refer to the link, [Spring Authorization Server]https://docs.spring.io/spring-authorization-server/reference/getting-started.html
I'll wish you luck!

The mock-center project is a server to imitate the MyData Center API which is the MyData Support API to support CA(Certificate Authorities), MyData business organizations, relay agencies. With this project, we can easily test the MyData project to communicate with the MyData Center in local environment before an integration testing.

First of all, we should create a skeleton of the project. This project will use the Spring Boot framework with several dependencies which are Spring Boot Web, Spring Boot Data JPA, Spring Security OAuth2 Authorization Server, Spring Security OAuth2 Resource Server and H2 Database.

The following is the order to create the project.

1. Create a Spring Boot project via Spring Initializr.
2. Add dependencies above.
3. Create a sample table in H2 Database.
4. Create a JPA model for the above sample table.
5. Create a sample REST api.
6. Run the Spring Boot program.

First of all we need to register an organization to the portal project(change mock-center to mock-portal project).
MyData business operators, Information Providers, Relay Agencies and Certificate Authorities must register to the MyData Portal to use MyData services.

The following link describes the procedure to register.
https://www.mydatacenter.or.kr:3441/myd/useguide/guide1.do

The following are the requirements that we will accept.

• Register an organization member.
• Organization's informations needed are
  • Organization type (MyData Business Operator, Information Provider, etc.)
  • Business number
  • Organization name
  • Organization code
    (refer to https://www.mydatacenter.or.kr:3441/myd/bbsctt/normal1/normal/a2c6ff48-8e70-43e5-b595-df8cf2c68ec6/17/bbsctt.do)
  • Classification (Bank, Insurance, Investment etc.)
  • Telephone number
  • Address
  • Representative
• Update an organization information.
• Unregister an organization.

Create a batch project to fetch data from other organizations regularly.
The batch project will use the Spring Batch framework. just create a skeleton of it for now.

Before we start this project we need to know backgroud knowledge about MyData.
Followings are what we need to know.

• What MyData is.

  • https://www.mydatacenter.or.kr:3441/myd/mydsvc/sub1.do
  • https://kdata.or.kr/kr/contents/mydata_01/view.do
  • https://dataonair.or.kr/edu/use-of-mydata/

• What kind of APIs we can use.

  • https://www.mydatacenter.or.kr:3441/myd/mydapi/sub1.do
  • https://developers.mydatakorea.org/mdtb/apg/dgi/bas/FSAG0101

The mock-other-org project is a virtual server to imitate an organization which is a business company providing My Data services. We can use this project to test APIs for provision of information.

The following is the sequence of items you should do to build the project.

1. Make the project to a Spring Boot project.
2. Add dependencies including Spring Web, Spring Security, Spring OAuth2 Authorization Server, Resource Server, Data JPA, H2Database.
3. Create a controller to test if it is working.

Go for it!

Change the frontend maven module project to a npm project.
Exclude the mock projects from the module projects.

The batch project is to execute batch jobs to be needed for the MyData services. While we develop the services, we need some jobs to be exeucted regularly for the MyData services. This project uses the Spring Batch framework.

The following is the list you need to do in order.

• Add the Spring Boot Batch dependency.
• Define a sample job using classes.

And refer to the link, Spring Boot Batch guide

Create a parent project and the following module projects

• Frontend
• Backend
• Authorization
• MockOtherOrg
• MockCenter
• MockCA

For more information about module projects, check out the README.md file.

The mock-ca project is an utility project to test APIs for integration authorization. This project will replace a Certificate Authority.

The following is the items to do in sequence.

1. First of all make the project to Spring Boot project.
2. Add dependencies to be needed, that is, Spring Web, Spring Security OAuth2 Authorization Server, Data JPA and H2Database.
3. Write a REST Controller to check if it is working.

Good luck!

This backend project is the core project of this repository. This project provide services to users and other MyData service organizations. This project need some effective features to manage users' MyData and provide them useful informations. First of all, build a skeleton for the real development.

The following is the list you should do in order.

• Add dependencies, Spring Web, Spring Security, H2Database and JPA.
• Configure in the application.yml file.
• Create a sample REST endpoint.

And refer to the link, Spring REST Service Guide

Good luck!!