外媒速递:API说明文档相关最佳实践综述

原创
新闻
API的实际效果在很大程度上取决于其文档质量。如果人们不知道该如何使用,那么,再出色的API也将毫无用武之处。这也引出了今天的讨论议题——我们该如何编写出理想的API说明文档?

【51CTO.com原创稿件】外媒速递是核子可乐精选的近日国外媒体的精彩文章推荐,希望大家喜欢!

本期给大家推荐的是API说明文档相关***实践综述、十二项基本要素助你走向云成功、六项提示帮你利用技术转型实现DevSecOps和十款免费插件助你在WordPress中实现各类动画效果等。

一、API说明文档相关***实践综述

原文标题:Best Practices in API Documentation

API说明文档相关***实践综述

API的实际效果在很大程度上取决于其文档质量。如果人们不知道该如何使用,那么,再出色的API也将毫无用武之处。这也引出了今天的讨论议题——我们该如何编写出理想的API说明文档?与技术领域的其它任务一样,文档编写同样应当遵循以下几项***实践。

1. 明确API说明文档的具体受众

2. 验证机制

3. 错误消息

4. 资源

5. 使用方式

6. 变更日志

7. 避免大量使用术语

8. 处理请求与响应

9. 将更多资源引入您的说明文档

10. 提供上手指南

11. SDK与库

12. 交互式控制台

13. 良好的API说明文档需要投入时间与精力方可建立,但确实物有所值

二、十二项基本要素助你走向云成功

原文标题:12 Factors to Cloud Success

作为一位开发者,大家是否希望你的应用程序能够配合各项***实践在云环境中取得理想运行效果?如果答案是肯定的,那么请关注“十二因素应用”这一概念。这是一种专门用于构建软件即服务的方法。在今天的文章中,我们将共同了解这“十二因素”,并探讨它如何提升我们的云应用运行表现。

1. 代码库

2.依赖关系

3. 配置

4. 后端服务

5. 构建、发布与运行

6. 流程

7. 移植绑定

8. 并发性

9. 可处置性

10. 开发/生产部分

11. 日志

12. 管理员流程

三、六项提示帮你利用技术转型实现DevSecOps

原文标题:6 Tips for Transforming Technology to Achieve DevSecOps

DevSecOps的核心目标在于为快速与安全软件开发建立起一道对接桥梁。作为DevSecOps的基础,我们应当将DevOps与AppSec加以结合,并高度关注如何利用质量与流程机制支持持续改进与快速学习。然而,如果缺少必要的技术方案,那么,DevSecOps同样无从谈起。下面,我们将了解六项能够帮助大家实现相关技术转型的重要提示。

1. 安全自动化

2. 尽早检测安全漏洞

3. 对Build进行拆分

4. 关注高误报率问题

5. 使用综合分析机制

6. 强调编排的重要作用

四、十款免费插件助你在WordPress中实现各类动画效果

原文标题:10 Free Plugins for Animation Effects in WordPress

[[195699]]

时至今日,动画效果已经成为各类WordPress网站实现个性化表达的重要途径。另外,动画效果也能够帮助大家成功将受众的注意力引导至关键性内容身上,从而强化用户体验。在今天的文章中,我们将共同了解十款可用于实现多种动画效果的免费插件。

1. SVG Logo

2. Animate It

3. Page Loading Effects

4. Page Animations and Trasitions

5. WP Progress Bar

6. CSS3 Transitions

7. CSS3 Rotating Words

8. Easy Textillate

9. Page Scroll to ID

10. Ultimate Hover Effects

【51CTO原创稿件,合作站点转载请注明原文作者和出处为51CTO.com】

戳这里,看该作者更多好文

责任编辑:赵宁宁 来源: 51CTO专栏
相关推荐

2009-07-09 17:47:35

Java Servle

2017-02-16 08:36:24

API威胁机器学习

2017-06-28 08:31:11

Node.jsMVC微服务

2016-10-12 09:25:50

云架构框架应用

2017-10-30 08:53:22

2017-10-25 08:53:52

2017-09-30 08:55:14

AWSMongoDBGUI工具

2017-11-29 08:50:01

2017-09-08 08:48:18

Swift语言数据分段机器学习

2018-04-28 08:41:55

2017-04-24 08:56:13

代码编辑器移动应用漏洞

2017-11-07 08:53:14

Linux云技术自助商务智能

2017-03-16 08:46:29

云计算移动应用Kaggle

2017-09-05 08:57:04

2017-12-14 08:31:41

DevOps数据职能JavaScript

2017-04-05 08:51:33

APM云服务信息安全

2017-03-13 08:56:49

Android移动应用

2017-05-23 08:45:44

JavaScript云存储深度学习

2017-03-03 08:38:25

2017-04-04 19:02:34

WordPressWindows 10WiFi
点赞
收藏

51CTO技术栈公众号