1. Overview

Micro starter API Docs.

1.1. Version information

Version : 1.0

1.2. Contact information

Contact : Li Xingping
Contact Email : lixingping233@gmail.com

1.3. License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : null

1.4. URI scheme

Host : localhost:8080
BasePath : /
Schemes : HTTP, HTTPS

1.5. Tags

  • Users Entity : Simple Jpa Repository

  • Users Service : All apis

  • profile-controller : Profile Controller

  • tests : Operations about user

  • users-command-controller : Users Command Controller

  • users-query-controller : Users Query Controller

1.6. Consumes

  • application/json;charset=UTF-8

1.7. Produces

  • application/json;charset=UTF-8

2. Chapter of manual content 1

This is some dummy text

2.1. Sub chapter

Dummy text of sub chapter

3. Chapter of manual content 2

This is some dummy text

4. Chapter of manual content 2

This is some dummy text

5. Resources

5.1. Users Entity

Simple Jpa Repository

5.1.1. findOneByIdUsers

GET /api/users/search/findOneById
Responses
HTTP Code Description Schema

200

OK

ResourceOfOptionalOfobject
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/users/search/findOneById
Example HTTP response
Response 200
{
  "links" : [ {
    "href" : "string",
    "rel" : "string",
    "templated" : true
  } ],
  "present" : true
}

5.1.2. findOneUsers

GET /api/users/{id}
Parameters
Type Name Description Schema

Path

id
required

id

string
Responses
HTTP Code Description Schema

200

OK

ResourceOfUsers
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/users/string
Example HTTP response
Response 200
{
  "createdDate" : "string",
  "id" : "string",
  "lastModifiedDate" : "string",
  "links" : [ {
    "href" : "string",
    "rel" : "string",
    "templated" : true
  } ],
  "username" : "string"
}

5.1.3. findAllUsers

GET /api/users{?page,size,sort}
Parameters
Type Name Description Schema

Query

page
optional

page

string

Query

size
optional

size

string

Query

sort
optional

sort

string
Responses
HTTP Code Description Schema

200

OK

ResourcesOfUsers
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json

  • application/json;charset=UTF-8

  • application/hal+json

  • text/uri-list

  • application/x-spring-data-compact+json

Example HTTP request
Request path
/api/users{?page,size,sort}
Request query
{
  "page" : "string",
  "size" : "string",
  "sort" : "string"
}
Example HTTP response
Response 200
{
  "content" : [ {
    "createdDate" : "string",
    "id" : "string",
    "lastModifiedDate" : "string",
    "username" : "string"
  } ],
  "links" : [ {
    "href" : "string",
    "rel" : "string",
    "templated" : true
  } ]
}

5.2. Users Service

All apis

5.3. Profile-controller

Profile Controller

5.3.1. listAllFormsOfMetadata

GET /api/profile
Responses
HTTP Code Description Schema

200

OK

ResourceSupport
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/profile
Example HTTP response
Response 200
{
  "links" : [ {
    "href" : "string",
    "rel" : "string",
    "templated" : true
  } ]
}

5.3.2. profileOptions

OPTIONS /api/profile
Responses
HTTP Code Description Schema

200

OK

object
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/profile
Example HTTP response
Response 200
"object"

5.4. Tests

Operations about user

5.4.1. Updated user

PUT /tests/{username}
Description

This can only be done by the logged in user.

Parameters
Type Name Description Schema

Path

username
required

name that need to be deleted

string
Responses
HTTP Code Description Schema

200

OK

string

400

Invalid user supplied

No Content

404

User not found

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json

  • application/json;charset=UTF-8

Example HTTP request
Request path
/tests/string
Example HTTP response
Response 200
"string"

5.5. Users-command-controller

Users Command Controller

5.5.1. create

POST /api/create
Parameters
Type Name Description Schema

Body

userDto
required

userDto

UserDto
Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/create
Request body
{
  "id" : "string",
  "username" : "string"
}

5.5.2. update

PUT /api/update
Parameters
Type Name Description Schema

Body

userDto
required

userDto

UserDto
Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/update
Request body
{
  "id" : "string",
  "username" : "string"
}

5.6. Users-query-controller

Users Query Controller

5.6.1. list

GET /api/list
Responses
HTTP Code Description Schema

200

OK

< Users > array
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Example HTTP request
Request path
/api/list
Example HTTP response
Response 200
[ {
  "createdDate" : "string",
  "id" : "string",
  "lastModifiedDate" : "string",
  "username" : "string"
} ]

6. Security

6.1. mykey

Type : apiKey
Name : api_key
In : HEADER

7. Definitions

7.1. Link

Name Description Schema

href
optional

Example : "string"

string

rel
optional

Example : "string"

string

templated
optional

Example : true

boolean

7.2. OptionalOfobject

Name Description Schema

present
optional

Example : true

boolean

7.3. ResourceOfOptionalOfobject

Name Description Schema

links
optional

Example : [ "Link" ]

< Link > array

present
optional

Example : true

boolean

7.4. ResourceOfUsers

Name Description Schema

createdDate
required

Example : "string"

string (date-time)

id
required

Example : "string"

string

lastModifiedDate
optional

Example : "string"

string (date-time)

links
optional

Example : [ "Link" ]

< Link > array

username
required

Example : "string"

string

7.5. ResourceSupport

Name Description Schema

links
optional

Example : [ "Link" ]

< Link > array

7.6. ResourcesOfUsers

Name Description Schema

content
optional

Example : [ "Users" ]

< Users > array

links
optional

Example : [ "Link" ]

< Link > array

7.7. UserDto

Name Description Schema

id
optional

Example : "string"

string

username
required

Example : "string"

string

7.8. Users

Name Description Schema

createdDate
required

Example : "string"

string (date-time)

id
required

Example : "string"

string

lastModifiedDate
optional

Example : "string"

string (date-time)

username
required

Example : "string"

string