Skip to content

zjx-immersion/api-stack

Repository files navigation

API Stack

Build Status

Capabilities todo list in API Stack

V1

  • API Test support with alone api test source set
  • API Test with Rest-assured
  • Spring boot with actuator for simple health check and metrics
  • Test coverage report and verification with Jacoco
  • IDE feature support like git、java
  • Project folder with multi level structure
  • Config support multi ENV with spring profile
  • Config content reading with unify mode (eg:@ConfigurationProperties)
  • Check Style support with customized config
  • ORM support: JAP with local env connect H2
  • JAP with Dev env connect Mysql 7 and multi name rule persistence operation in JPA Respostory
  • DB managements like Flyway/Liquibase
  • Object mapping abstract with Orika
  • JUnit Test Support - Include Spring Test Starter(Already Include Junit) and Mockito
  • Junit with JUnitParams
  • Log Aspect and Logback format for multi ENV
  • API request exception handling strategy and record them in log in public framework
  • API Error request unify response formation
  • CORS simple Support
  • Request & Response gzip support
  • API quick access UI support: Swagger ui
  • Security and Authentication support with Auth 2.0 and JWT and Spring Security
  • API /info with production ready info (like: version, name, build number etc.)
  • CI process like Jenkins pipeline
  • Remote debug support
  • Cache support
  • Internationalization (i18n)
  • The unify way to call dependence service
  • API version support
  • Rest api playload standard building like JaonAPI/HAL
  • Build jar in container
  • Containerized the env API server
  • Containerized the env DB
  • File upload and download support like Image
  • Hot Reload when doing some updates

V2

  • CORS Support including client validation
  • Customer Driven Contract Testing - (Tool advice: spring boot contract or Pact)
  • Ansible deploy process strategy
  • Containerized building and running with newest Docker multi build feature
  • Spring Cloud support for microservice basic stack

Contribution

if you wang to pick any item upon, please click Board, and choose the corresponding crad which exist in todo list. When you start a card, please convert this card to a issue and create a separated branch for implementation, then create a pull request for merging to master.

About

Full Stack with Spring boot API develop stencil

Resources

Stars

Watchers

Forks

Packages

No packages published