elemefe / restc

A server-side middleware to visualize REST requests.

中文文档

Introduction

restc is an HTTP server middleware, aiming to enhance debugging experience on RESTful APIs.

It can be easily integrated with popular HTTP frameworks. You will see:

• formatted JSON responses in the browser
• a debug panel with which you can send GET, POST, PUT, PATCH and DELETE requests directly in the browser

You can even share a request by sharing its URL directly to others and everything will be automatically filled in the panel.

Getting Started

npm install --save restc

Use the middleware

const restc = require('restc');
// for express
app.use(restc.express());
// for koa
app.use(restc.koa());
// ...and koa2
app.use(restc.koa2());
// for hapi
server.register(restc.hapi)
// for hapi of legacy version
server.register([{
  register: restc.hapiLegacy
}], (err) => {
  if (err) {
    throw err
  }
})

restc's Issues

请问文档用什么工具写的，界面好舒服

请问文档用什么工具写的，界面好舒服

restc不支持RESTful的accept方式控制版本号

必须
Accept: application/json, /
Accept: application/vnd.github.v3+json
两个都写，不然会报错
虽然并不影响正常运行，但能否实现支持

In version 0.2.0, file not found

In version 0.2.0, files not found at
https://github.elemecdn.com/highlightjs/

https://github.elemecdn.com/codemirror/CodeMirror

KOA2+webpack middleware +restc 运行问题

webpack middleware与restc搭配一起运行，restc打开接口地址，直接提示下载，无法显示页面，response返回的content type 并不是txt/html 。

后面直接修改源代码，重新设定了响应的类型，之后正常

Display issue on project website

Hi, I have some issue to read project website : many font character are not available in my locale (en_US) and with my fontset, as you can see below

Headers with the same keys are combined

For example, if the response header contains:

Vary: foo
Vary: bar

restc will transform it into:

Vary: foo, bar

However, the two Varys should not be combined here.

Since getAll() is deprecated and get() returns a combined string instead of an array, this issue may be not easy to solve.

Content-Disposition parsing issue

Currently, restc only recognizes the following form of Content-Disposition:

Content-Disposition: ...; filename="foo.bar"

Thus, the filenames of some attachments may be unexpectedly dropped.

Nodejs v10 http response status code default value is 404

Nodejs v10 http response status code default value is 404

eggjs中使用不生效

你好，在eggjs中添加restc中间件，执行了但是并没有生效，请问是什么原因？代码是egg中写的中间件代码：

KOA2 使用 想渲染html 时怎么弄？

静态文件使用没问题，但是用模版引擎渲染一些html而不是json接口时，依然会走restc的服务，这个时候怎么强制输出html？

在firefox47.xx版本上，有css错误

操作环境：win7，firefox47，
页面右侧工具栏有显示，页面左则内容为空白，其实接口有返回

只在css栏有错误日志

Support Hapi?

Hapi has official project similar like your project, https://github.com/hapijs/tv , Both are awesome!

关于静态资源的引用

不支持加载本地js和css文件吗？内网用不了啊。。。。。。

按照demo引入

写入 res.set('Content-Type', 'application/octet-stream')后
postman没问题，浏览器打开，直接下载一个文件后缀为dms

只应用于 API

今天第一次用，发现页面也成为了 restc 的页面， 所以有没有一些选项能让我指定只针对某些规则的 url . 或者其他的方式可以绕过不应该转变为 restc 的页面

我目前是这么做的：

if (DEVELOPMENT) {
    app.use(async (ctx, next) => {
        if (ctx.url.indexOf('/api') !== -1) {
            return restc.koa2()(ctx, next)
        }
        return next()
    })
}

中文文档“Nginx配置”跳转错误

中文文档指南(文档正文，非目录)中，直接跳转至Nginx配置有问题。:smile:

如何在apache中引入呢？是否支持其他格式的显示

本地环境wamp ，文档只说了Nginx 没说apache，另外xml格式的响应支持吗？

Add optional parameter to only affect specify url

Like this:

// import restc
const restc = require('restc');
// use restc middleware
app.use(restc({only: ['/api'], except: ['/web']}).express());

希望添加代码折叠功能

对于返回数据比较复杂的接口，折叠功能会更加方便让开发者进行调试。

Nginx方式配置报400

400.1 无匹配的主机名，页面出不来

301/302 redirect page

Says we currently have an API redirects user to another page:

Request --> API --> PageA

restc send a request from frontend with fetch instead of jumping page which breaks the process, currently I have to disable restc on prod env.

thanks in advance

在nginx中引入,调试php接口不起作用

nginx config

server {
    listen 8000;

    root /home/restc;
    index index.php index.html index.htm;

    location / {
        add_header Vary Accept;
        if ($http_accept ~* "text/html") {
                rewrite ^.*$ / break;
                proxy_pass https://restc.faas.ele.me;
        }
    }

    include enable-php.conf;
}

php file

echo '{"hello":"json"}';