Tips 原文作者:Liam Tung  原文地址:Developers rejoice: Microsoft, Google, Mozilla are putting all their web API docs in one place 浏览器厂商已经同意将Mozilla的MDN Web文档作为web API信息的主要存储库. 三家大型浏览器厂商已经同意将他们的跨浏览器文档放到Mozilla开发者网络(MDN)维基百科上. Mozilla的MDN Web文档现在将成为关于Web API和关于…
最近,公司项目要求在页面中嵌入地图,需求还算简单,但是由于必须具备响应式(主要是pc和移动端),而且由于公司业务是全球性的,要支持国外地点搜索.考虑到百度,腾讯,高德等等国内地图无法显示国外数据,谷歌在国内基本被废,对于全球通用的地图,目测只有微软的必应可以支持了(那些国外小厂的地图插件暂且不提).虽然必应地图没有谷歌那么强大,但也基本能满足业务需求.所以在此做个简单的记录,方便以后查阅,也方便与我有同样需求的人参考.如有不对,欢迎指正. 官网地址:https://www.bingmapspor…
当你开发了一个库的时候,就需要给库开发一个api文档,微软提供了一个C#库的自动生成工具.我在使用的过程中记录了相关的信息,以供大家学习和查阅,如有不正之处,欢迎指出. 首先先下载一个软件,下载地址在github上:https://github.com/EWSoftware/SHFB/releases 下载最新的版本即可.到本地后开始安装 先安装上面的msi文件,安装好以后,点击下面的文件 现在还是打开不了的,还需要下载个东西 这里有个提示很重要:意思是如果想使用单独的GUI程序,需要安装Mic…
api文档编写好像很简单,其实不是.一个良好的api文档,需要就有以下内容:接口详细描述,接口参数详细描述,接口返回结果详细描述,容易理解的范例.这些内容其实是不少的,编写过程中还非常单调乏味.再加上项目紧张,积压的未编写api文档太多等等因素,造成了现实工作中,大部分api文档都是残缺不全的状况.从结果上看,编写api文档并不简单. api文档编写好像只是后端工程师一个人的事情,其实不应该是.实际工作中,api文档都是由实现这个api的后端工程师根据api来编写的.因为api是某人开发的,他知…
编写技术文档,是令众多开发者望而生畏的任务之一.它本身是一件费时费力才能做好的工作.可是大多数时候,人们却总是想抄抄捷径,这样做的结果往往非常令人遗憾的,因为优质的技术文档是决定你的项目是否引人关注的重要因素.无论开源产品或面向开发者的产品,均是如此. 实际上,我想说明的是:对于面向开发者的产品来说,其用户体验中最重要的一环并不是什么主页设计.登录过程.或者SDK下载.真正最重要的是产品的API文档!如果没人知道你的产品如何使用,纵使它巧夺天工,又有何用? 如果你是一个专门从事面向开发者产品设计…
=====================先来一点成就感===================== package com.springMybatis.dao; import com.springMybatis.model.*; /** * AuthorizationDao 定义Authorization接口 * @author g.qu * @see java.lang */ public interface AuthorizationDao{ /** * addAuthorization 添…
前言 相信很多后端开发在项目中都会碰到要写 api 文档,不管是给前端.移动端等提供更好的对接,还是以后为了以后交接方便,都会要求写 api 文档. 而手写 api 文档的话有诸多痛点: 文档更新的时候,需要再次发送给对接人 接口太对,手写文档很难管理 接口返回的结果不明确 不能直接在线测试接口,通常需要使用工具,如 postman 等 Swagger 就很好的解决了这个问题. Swagger 简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 W…
Java,面试题,简历,Linux,大数据,常用开发工具类,API文档,电子书,各种思维导图资源,百度网盘资源BBS论坛系统 ERP管理系统 OA办公自动化管理系统 车辆管理系统 家庭理财系统 各种后台系统 一.面试题.简历资源 二.各类思维导图 三.大数据学习 四.Linux 五.各类常用开发工具类 六.百度网盘各类资源,包含java开发,项目实战,MYSQL,框架学习,大数据,Linux等等,应有尽有 百度网盘面试题资源 MySQL数据库 七.管理系统 程序员的道路,是一个不断不断不断学习的…
经历过14个月的等待,本书终于上市了,完全口语化叙述,请参考右边的链接. 本书介绍 本书无关于JavaScript设计模式,也无关于JavaScript面向对象代码实现.本书的写作目的也不是鉴别JavaScript语言特点的好坏.本书并不是一本完整的参考指南.它面向的读者人群并不是编程新手或对JavaScript完全陌生的人员.同时,它也不是一本JavaScript攻略手册.关于上述这些方面的书籍都已经面世. 本书的撰写意图是通过考察原生JavaScript对象和不同环境对原生对象的支持的细微差…
(继续贴一篇之前工作期间写的经验案例) 一.           案例背景 我负责开发过一个平台的监控报警模块,基于zabbix实现,需要对zabbix进行二次开发. Zabbix官方提供了Rest API的文档,并推荐了第三方库,但这些库都是zabbix老版本(2.2,2.4/3.0)的库,多年未更新过,且变量/方法命名都不符合java的驼峰式规范. 所以开发中基于3.4的文档,自己封装了一套库.结合二次开发中对zabbix业务逻辑的理解与实践,梳理总结出该篇接口开发文档. 二.       …