# @mrapi/api usage documentation

@mrapi/api serves as the API layer to directly provide services to the client, which can aggregate other openapi/graphql interfaces and operate the database through prisma.

# core

Log multi-terminal (file + terminal) output, automatic division

# install

npm install @mrapi/api --save

# `standalone` mode

Reference api-basic project
Note: Does not provide database operation capabilities

# First, configure the basic configuration file

// config/mrapi.config.js
exports.default = {
  api: {
    openapi: {
      dalBaseUrl: 'http://ip OR domains' // openapi代理目的地地址
    },
    graphql: {
      sources: [
        {
          name: 'graphqlSourceName',
          endpoint: 'http://ip OR domains', // 源graphql服务地址
          prefix: 'prefix_', // graphql operationName前缀
          snapshot: false // 请求graphql快照
        }
      ]
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Note: For other configuration items, please refer to API configuration

# Second, start the API service

import Api, { log } from '@mrapi/api'

(async function () {
  const api = new Api()
  await api.start()
})().catch((err) => {
  log.error(err)
})

1
2
3
4
5
6
7
8

# Third, Access service

Server listening at http://127.0.0.1:1358
# access playground http://127.0.0.1:1358/playground
# access graphql http://127.0.0.1:1358/graphql/default
# access custom openapi http://127.0.0.1:1358/api/xx
# For other routes, please check the terminal print Routes Tree

1
2
3
4
5

# `combined` mode

Reference api-combine project
Note: Graphql-mesh and openapi proxy capabilities are not provided
Carry tenant information through headers['mrapi-pmt'], and change the key value through tenantIdentity in mrapi.config.js
Select the schema graphql interface and use /graphql/:schemaName to determine which schema corresponds to the prismaClient, and the /graphql prefix can be modified through api.graphql.path
Select the schema openapi interface and use headers['mrapi-schema'] to determine which schema corresponds to the prismaClient. You can change the key value through api.schemaIdentity in mrapi.config.js

# First, Configure the basic configuration file

// config/mrapi.config.js
exports.default = {
  managementUrl: 'mysql://root:123456@127.0.0.1/management',
  api: {
    schemaNames: ['one'], // prisma schema names
    server: {
      type: 'combined',
    },
  }
}

1
2
3
4
5
6
7
8
9
10

Note: For other configuration items, please refer to API configuration

# Second, Configuration before startup

Please refer to the DAL document and configure prisma related dependent files and configuration items, otherwise it may cause startup failure

# Third, Start API service

import Api, { log } from '@mrapi/api'

(async function () {
  const api = new Api()
  await api.start()
})().catch((err) => {
  log.error(err)
})