@kokoye2007/microservice-blueprint-nodejs
v0.1.20
Published
A Blueprint to crate Node JS Micro-Service on apifie platform
Downloads
4
Maintainers
Readme
@apifie/microservice-blueprint-nodejs version : 1.0.0
microservice-blueprint-nodejs NPM Module
Running microservice-blueprint-nodejs module
To run independently (is not required though)
npm start
To run this module within an example-service
npm run example-service
To test this module
npm test
npm run test:unit
npm run coverage
Using microservice-blueprint-nodejs module
We need to create a micro-service that uses this module as its dependency. Below documents give a detail walk-through and how-to-guides for these consumer micro-services
- 1.Creating a new micro-service
- 2.Upgrading to a newer version of blueprint
- [ ] 2.1 How to upgrade microservice-blueprint-nodejs version [TODO : GK]
- [ ] 2.2 How to upgrade cicd-blueprint version [TODO : AS]
- [x] 3. How to Manage external systems and components
- [X] 4. Understanding startup / bootstrapping flow of your service
- 5. Testing your service
- [ ] 5.1 Test helpers offered out-of-box by microservice-blueprint-nodejs [TODO : xx]
- [ ] 5.2 How to write Unit test cases [TODO : xx]
- [ ] 5.3 How to write Integration test cases [TODO : xx]
- [ ] 5.4 How to write Scenario / API Flow tests [TODO : LC]
- 6. API specifications for your service
- [ ] 6.1 Understanding Swagger Specs generation [TODO : LC]
- [ ] 6.1 Understanding Postman collection generation [TODO : LC]
- 7. Understanding API Route handling
- [ ] 7.1 Interceptors offered out-of-box by microservice-blueprint-nodejs [TODO : LC]
- [ ] 7.2 API Routes offered out-of-box by microservice-blueprint-nodejs [TODO : LC]
- [ ] 7.3 How to add service specific middleware request / response interceptors [TODO : LC]
- [ ] 7.3 How to add service specific api routes [TODO : LC]
- 8. Understanding Database (ORM) design
- [ ] 8.1 How to add a new model [TODO : CP]
- [ ] 8.2 How to manage database migrations [TODO : CP]
- [x] 9. How to use Caching component (Redis)
- 10. Understanding logging and tracing component
- [ ] 10.1 How to use logger [TODO : DSM]
- [ ] 10.2 How to use tracer [TODO : DSM]
- [x] 11. Understanding apifie Message Queue Interface
- 12. Best practices and guidelines
- [x] 12.1 Recommended Project Structure for your micro-services
- [ ] 12.2 Conventions and coding patterns [TODO : GK+]