README.md

MyPub Service

MyPub web backend to provide user-centric services.

This is intended to be held by a trustworthy decentralized organization.

Configuration

Global Properties

GlobalProperties.java

• workspace workspace location
• encryptor encryptor name

Encryptor

Compile and distribute MyPub Encryptor into workspace.

Commands

Require encryptor in workspace

Compile

mvn package

Run

java -jar *.jar

API

http://localhost:8080/swagger-ui/

Contact information:
Yepeng Ding
https://yepengding.github.io/

License: MIT License

/cipher/encrypt

POST

Summary:

encrypt

Parameters

Name	Located in	Description	Required	Schema
file	body	file	Yes	binary

Responses

Code	Description	Schema
200	OK	CommonResult«Encrypted»

/file/{name}

GET

Summary:

getFileByCID

Parameters

Name	Located in	Description	Required	Schema
name	path	name	Yes	string

Responses

Code	Description	Schema
200	OK	Resource
403	Forbidden
500	Internal Error

Models

CommonResult«Encrypted»

Name	Type	Description	Required
code	long		No
data	Encrypted		No
message	string		No

Encrypted

Name	Type	Description	Required
decryptor	string		No
file	string		No
key	string		No

InputStream

Name	Type	Description	Required
InputStream	object

Resource

Name	Type	Description	Required
description	string		No
file	file		No
filename	string		No
inputStream	InputStream		No
open	boolean		No
readable	boolean		No
uri	string (uri)		No
url	string (url)		No

MyPub Components

• MyPub Front + Chain Linker
• MyPub Contract
• MyPub Cipher
  • Encryptor
  • Decryptor
• MyPub Service

Reference

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• Spring Data JPA
• Spring Web
• Thymeleaf
• swagger
• guava