Skip to content

Commit c2e9d1d

Browse files
committed
docs(json-api-nestjs): Add describe
add micro orm in readme Closes: 97
1 parent e492cd1 commit c2e9d1d

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
<p align="center">
2-
Json API plugins for
3-
<a href="http://nestjs.com/" target="blank">NestJS</a>
4-
framework
2+
<a href="http://nestjs.com/" target="blank">NestJS</a> JSON API & JSON RPC Suite
53
</p>
4+
65
<p>
7-
Tools to implement JSON API, such as, end point, query params, body params, validation and transformation response.
6+
This monorepo contains a set of several libraries designed to simplify the development of server and client applications using NestJS. These tools help you work with two popular protocols:
87
</p>
98

10-
- *[json-api-nestjs](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs)* - plugin for create CRUD overs JSON API
11-
- *[json-api-nestjs-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs-sdk)* - tool for client, call api over *json-api-nestjs*
12-
- *[nestjs-json-rpc](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc)* - plugin for create RPC server using [JSON-RPC](https://www.jsonrpc.org/)
13-
- *[nestjs-json-rpc-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc-sdk)* - tool for client, call RPC server *nestjs-json-rpc*
14-
- *json-api-nestjs-acl* - tool for acl over *json-api-nestjs*(coming soon...)
9+
10+
- **[JSON:API](https://jsonapi.org/)** – A specification for building RESTful APIs with standardized request and response formats.
11+
12+
> **[json-api-nestjs](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs)** - This package enables you to quickly set up a server API that adheres to the JSON:API specification, handling standard CRUD operations for your resources.</br>
13+
> **[json-api-nestjs-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api/json-api-nestjs-sdk)** - tool for client, call api over *json-api-nestjs*
14+
15+
16+
- **[JSON-RPC](https://www.jsonrpc.org/)** – A protocol for remote procedure calls using JSON.
17+
18+
> **[nestjs-json-rpc](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc)** - Use this package to implement remote procedure call (RPC) functionality in your NestJS applications, enabling efficient inter-service communication.</br>
19+
> **[nestjs-json-rpc-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-rpc/nestjs-json-rpc-sdk)** - This tool offers a straightforward way to call remote procedures from your client-side code, ensuring smooth communication with your JSON-RPC server.
20+
21+
- **ACL tools** - tool for acl over *json-api-nestjs*(coming soon...)
1522
## Installation
1623

1724
```bash

libs/json-api/json-api-nestjs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
# json-api-nestjs
1010

11-
This plugin works upon TypeOrm or MicroOrm library, which is used as the main database abstraction layer tool. The module
12-
automatically generates an API according to JSON API specification from the database structure (TypeORM entities). It
11+
This plugin works upon **TypeOrm** or **MicroOrm** library, which is used as the main database abstraction layer tool. The module
12+
automatically generates an API according to JSON API specification from the database structure (**TypeOrm** or **MicroOrm** entities). It
1313
supports features such as requests validation based on database fields types, request filtering, endpoints extending,
1414
data relations control and much more. Our module significantly reduces the development time of REST services by removing
1515
the need to negotiate the mechanism of client-server interaction and implementing automatic API generation without the

0 commit comments

Comments
 (0)