Component Organization for Distributed APIs
- Updated2023-02-17
- 1 minute(s) read
Component Organization for Distributed APIs
Refer to the following table for best practices for organizing components.
| Guideline | Required or Recommended? | Details |
|---|---|---|
|
Set the Exported or Non-exported designation of the VIs in your API appropriately. |
Required |
The Exported designation indicates to users which VIs are guaranteed to have a consistent interface. |
|
Mark a VI as Exported only if it is a public member of your API. |
Required |
Mark a VI as Exported. |
|
If a G Type is on the connector pane of an exported VI in your API, also mark that G Type Exported. |
Required |
N/A |
|
Follow the namespacing guideline [Company].[Product].[Component].gcomp for your API component. |
Required |
For example, NI.G Core.Data Type.gcomp is a component NI owns, part of the G Core product (in other words, the core libraries that compose the G language), and these VIs pertain to parsing Data Types. |
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.
- 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.