npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@micro-app/plugin-koa

v0.5.4

Published

[Plugin] koa adapter plugin.

Downloads

6

Readme

Micro APP Plugin Koa

[Plugin] koa adapter plugin for micro-app.

Micro APP 依赖 Koa 插件.

Coverage Status CircleCI NPM Version NPM Download

Install

yarn add @micro-app/plugin-koa

or

npm install -D @micro-app/plugin-koa

Usage

在 microapp/config 中配置

'use strict';

module.exports = {
    ...
    alias: {
        config: './src/config',
        helper: './src/helper',
        service: './src/service',
        plugin: './src/plugin',
        middleware: './src/middleware',
        router: './src/router',
    },
    server: {
        entry: 'app.js',
        options: {
            abc: 123,
        },
        cc: 1,
    },
    devServer: {
        port: 6666,
    },
};

入口文件 server.entry

分发调用指定的模块,其中 router 为必须项

'use strict';


module.exports = function(app) {

    // // 增强 $config
    // app.$dispatcher('config', require.resolve('@micro-app/test/config'));
    // // 配置全局 helper
    // app.$dispatcher('helper', require.resolve('@micro-app/test/helper'));
    // // 配置全局 service
    // app.$dispatcher('service', require.resolve('@micro-app/test/service'));
    // // 配置全局 plugin
    // app.$dispatcher('plugin', require.resolve('@micro-app/test/plugin'));
    // // 配置全局  middleware
    // app.$dispatcher('middleware', require.resolve('@micro-app/test/middleware'));
    // 配置路由 router
    app.$dispatcher('router', require.resolve('@micro-app/test/router'));

    return app;

};

开启 swagger

配置 .env 文件,开启 Swagger,只支持 src/**/*.js 目录下文件

DOCS_SWAGGER=true

通过扩展配置 DOCS_SWAGGER_ROOT,可支持其它目录 path.resolve(process.env.DOCS_SWAGGER_ROOT, '**/*.js') 目录下文件

DOCS_SWAGGER_ROOT={{ dirname }}

配置 swagger 文档,需要在接口方法中增加注释,如下:

// https://www.npmjs.com/package/swagger-jsdoc
/**
 * @swagger
 * /api/docs/swagger.json:
 *   get:
 *     summary: 返回 swagger.json
 *     description: 返回 json 格式的 swagger.json
 *     responses:
 *       200:
 *         description: 成功
 */
router.get('/swagger.json', swaggerRoutes.swaggerJson());

/**
 * @swagger
 * /api/docs/swagger:
 *   get:
 *     summary: swagger 页面
 *     description: swagger 展示所有接口
 *     responses:
 *       200:
 *         description: 成功
 */
router.get('/swagger', swaggerRoutes.swagger());

可参考:https://editor.swagger.io/

访问接口文档

/api/docs/swagger
// or
/api/docs/swagger.json