Welcome to Port¶

More Easily Create an API Servers, designed to streamline the deployment of APIs for developers. With this tool, developers can effortlessly deploy APIs and integrate various applications to build a unified web service. Port Application simplifies the process, enabling developers to focus on creating seamless and efficient solutions with ease.

Please see the documentation lincense

The Requirements¶

---

• os : windows 7+ / windows server 2003+
• memory : minimum 32GB
• frameworks : .Net 8.0+

Download URL¶

---

VERSION	OS	STABLE	URL
v1.0.20	Windows x64	No	v1.0.20-win-installer

Repository¶

---

To deploy APIs, you must first store the API definitions in the repository before proceeding with the deployment. Please refer to the instructions below for guidance on storing and deploying your APIs after saving them to the repository.

Creates a repository¶

port new [repository-name]

---

Layout¶

port.toml         # The configuration file.
.enum             # The custom enum file 
API-A-Group/      # The group directory. 
    sample1.msg   # The message file
    sample2.msg   # The message file
    sample3.msg   # The message file

API-B-Group/      # The group directory. 
    sample1.msg   # The message file
    sample2.msg   # The message file
    sample3.msg   # The message file
...               # Other files.

---

---

Creates a API-Groups¶

port add [group-name]

---

Message (*.msg)¶

A message is an object that allows users to specify API properties in a pre-provided Application Service. The message is a kv, and types and properties can be defined in that message. Please attach the materials attached below.

---

• message item format like this [key] [datatype] [option...]
• [key] - unique key in the message group
• [datatype] - text | num
• [option] - api,backup,rule,frame

message attribute¶

name	description
api	Real-time synchronization and messaging are handled within the corresponding external library. For more details, please refer to the api documentation.
backup	Changes are saved to the backup database as they occur, ensuring that values are restored upon application restart. and values are not propagated api messages during program execution.
property	Can specify a custom property
rule	Can specify rules to manage the values of corresponding messages.

sample1.msg¶

 DevAPowerStatus    enum.DeviceAStatus  api:DeviceA.GetStatus         
 DevAErrorMessage   text                api:DeviceA.GetErrorMessage property:{"Arguments":"1,0"}
 DevCTemperature    num                 api:DeviceC.GetTemperature property:{"MIN":0,"MAX":300}
 DevCOnOff          enum.OnOff          api:DeviceC.OnOff           
 ...

Enum (*.enum)¶

---

Enums are particularly useful when you have a fixed set of values that a variable can take, such as days of the week, months of the year, or status codes. They help make your code more expressive, self-documenting, and less error-prone because you're working with named constants instead of raw integer values.

• enum item format like this[key] [item-name:number_key] [item-name:number_key]
• [key] - unique key in the enum message
• [item-name]- name by enum-item
• [property] - unique key in enum value

custom.enum¶

TFalse      True:0      False:1
FTrue       False:0     True:1

Commands¶

---

Repository¶

• port push - push project to repository
• port pull - pull project from repository

Application¶

• port run [repository-name] - run application from repository
• port kill - terminated current application

Message¶

• port set [group-key] [message-key] [set-value] - set the message value to current repository

port set groupA sayHelloMessage1 Hello?
[set-ok]

• port get [group-key] [message-key] - get the message value to current repository

port get groupA sayHelloMessage1
[Hello?]