Best Practices for Designing and Developing an Application Programming Interface (API) in G Web Development Software
- Updated2023-02-17
- 1 minute(s) read
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:
You also need to follow the Best Practices for Designing and Developing Projects in G Web Development Software if you want your API to be consistent with NI best practice recommendations for G content.
Throughout this section, the term required refers to a guideline that NI requires when designing an API. The term recommended refers to a guideline that NI suggests when designing an API.
Related Information
- 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.
- Documentation for Distributed APIs
Refer to the following table for best practices for documenting an API.
- 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.