如果要给 RESTful 每种 HTTP Method 类型指示一种颜色

RESTful 时需要考虑每种 HTTP Method 操作的业务含义,再也不是 GET 使用 URL, POST 提交表单这样简单的区别。http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html 定义有 GET, POST, PUT, HEAD, DELETE, PATCH, OPTIONS, TRACE, CONNECT 九种类型的 HTTP Method。

关于它们可能针对的业务含义就不多说了,而是如果要对每一种操作方法赋予一个颜色应该怎么去对应呢,比如一般 GET 不会有边际效应的操作可以选择绿色,或者蓝色。幸好我也不用多想,这里参考了 Swagger 的颜色方案,它支持除 OPTIONS, TRACE 和 CONNECT 之外的颜色配置,其实我也没用过这两种方法。

从 Play2 Swagger 中截图如下:

http-method-colors

Swagger 不支持 OPTIONS 的配色,其余的可以用工具从上图中抠出对应的颜色,也可以从它所用的 CSS 文件 swagger-screen 中找到相应的配置。这里简略列出

GET: #0f6ab4POST: #10a54aPUT: #c5862bDELETE: #a41e22PATCH: #D38042HEAD: #ffd20f

但是从 https://github.com/wordnik/swagger-ui/blob/master/src/main/less/specs.less 看到的 OPTIONS 彩的是和 GET 一样的颜色。

参考:

  1. Using Color in API Documentation
  2. http://petstore.swagger.wordnik.com/
  3. https://github.com/wordnik/swagger-spec
  4. https://github.com/wordnik/swagger-ui

本文链接 https://yanbin.blog/restful-colors-for-http-methods/, 来自 隔叶黄莺 Yanbin Blog

[版权声明] Creative Commons License 本文采用 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 进行许可。

guest

0 Comments
Inline Feedbacks
View all comments