Documentation for Distributed APIs
- Updated2023-02-17
- 1 minute(s) read
Documentation for Distributed APIs
Refer to the following table for best practices for documenting an API.
| Guideline | Required or Recommended? | Details |
|---|---|---|
|
Review the VI description and parameter descriptions of all public VIs in your API for correct meaning for what the VI does, usability by third parties who are unfamiliar with your API, spelling, grammar, and naming conventions for G Web Development Software. |
Required |
N/A |
Related Information
- Best Practices for Designing and Developing an Application Programming Interface (API) in G Web Development Software
To develop an API to distribute to other users that is consistent with NI style recommendations for G content, refer to the following best practice guidelines:
- File Organization and Node Naming for Distributed APIs
Refer to the following table for best practices for organizing files and naming nodes.
- Component Organization for Distributed APIs
Refer to the following table for best practices for organizing components.
- Icons and Connector Panes for Distributed APIs
Refer to the following table for best practices for creating icons and connector panes.
- Panel Design for Distributed APIs
Refer to the following table for best practices for designing panels.
- Data Type Selection for Distributed APIs
Refer to the following table for best practices for selecting data types.
- Palette Taxonomy for Distributed APIs
Refer to the following table for best practices for palette taxonomy.
- Error Message Design for Distributed APIs
Refer to the following table for best practices for designing error messages.
- API Design for Distributed APIs
Refer to the following table for best practices for designing VIs.