BP2 | Provide Descriptive Metadata | 为API提供描述元数据。 |
BP12 | Use Machine-readable Standardized Data Formats | 数据及元数据使用机器可读的标准数据格式, 如CSV、XML、JSON和RDF等。 |
BP14 | Provide Data in Multiple Formats | 为数据资源提供多种格式。 |
BP18 | Provide Subsets for Large Datasets | 对于大型数据集, 能让消费者获取它的子集。这时, API是最灵活的方式。 |
BP20 | Provide Real-time Access | 通过API定期轮询或流媒体技术, 让消费者实时获取数据。 |
BP21 | Provide Data up to Date | 为消费者提供最新数据, 防止数据过时。 |
BP23 | Make Data Available through an API | 为数据资源提供API, 可以借助平台(如CKAN)的API功能, 或者API的开发框架。 |
BP24 | Use Web Standards as the Foundation of APIs | API建立在Web标准(主要是HTTP、REST等)之上, 使其易于理解、使用和维护。 |
BP25 | Provide Complete Documentation for Your API | 为开发者提供详细的API说明文档, 包括每个API的目的、参数、返回值和使用示例等。 |
BP26 | Avoid Breaking Changes to Your API | 避免API格式与文档的变化, 使客户端代码保持稳定。如需改进API, 最好以增量的方式并采用版本控制。 |