oRPC is a powerful combination of RPC and OpenAPI, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
You can find the full documentation here.
Deeply integrate oRPC with NestJS. Read the documentation for more information.
An overview of how to implement an oRPC contract in NestJS.
import { Implement, implement, ORPCError } from '@orpc/nest'
@Controller()
export class PlanetController {
/**
* Implement a standalone procedure
*/
@Implement(contract.planet.list)
list() {
return implement(contract.planet.list).handler(({ input }) => {
// Implement logic here
return []
})
}
/**
* Implement entire a contract
*/
@Implement(contract.planet)
planet() {
return {
list: implement(contract.planet.list).handler(({ input }) => {
// Implement logic here
return []
}),
find: implement(contract.planet.find).handler(({ input }) => {
// Implement logic here
return {
id: 1,
name: 'Earth',
description: 'The planet Earth',
}
}),
create: implement(contract.planet.create).handler(({ input }) => {
// Implement logic here
return {
id: 1,
name: 'Earth',
description: 'The planet Earth',
}
}),
}
}
// other handlers...
}
Distributed under the MIT License. See LICENSE for more information.
Share feedbackRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4
