API (Giao diện lập trình ứng dụng) là gì
Tập hợp các quy tắc và giao thức cho phép các ứng dụng phần mềm khác nhau giao tiếp với nhau. Nó xác định cách các yêu cầu và phản hồi nên được cấu trúc, cho phép các nhà phát triển sử dụng các hàm hoặc dịch vụ được định nghĩa sẵn mà không cần hiểu cơ chế hoạt động bên trong của chúng.
REST API trong IDEA StatiCa Connection - là một dịch vụ web được lưu trữ cục bộ tuân theo các nguyên tắc REST, cho phép các hệ thống giao tiếp bằng các phương thức HTTP tiêu chuẩn để thực hiện các thao tác trên tài nguyên, thường được biểu diễn ở định dạng JSON.
Tài nguyên và GITHUB
Nguồn các ví dụ có sẵn và được định nghĩa trước được liên kết trên GitHub của chúng tôi:
Cách bắt đầu
Hướng dẫn này sẽ được giới thiệu kết hợp với ngôn ngữ lập trình Python. Bạn có thể tải phiên bản mới nhất tại đây. Bạn có thể sử dụng nhiều Môi trường Phát triển Tích hợp (IDE) như các công cụ để lập trình, gỡ lỗi và kiểm thử hiệu quả. Dưới đây là một số lựa chọn:
Cách chạy API
Trình khởi chạy API có thể được tìm thấy trong thư mục lưu trữ phiên bản IDEA StatiCa mới nhất của bạn. Chỉ cần chạy tệp thực thi.
Nếu bạn chạy "IdeaStatiCa.ConnectionRestApi.exe," cửa sổ CMD (Command Prompt) sẽ xuất hiện và bạn có thể thấy localhost của mình cũng như mở ứng dụng Swagger, cho phép bạn xem cấu trúc mã để điều khiển API. Nhấn Control + Nút chuột trái để mở Swagger.
Swagger ở chế độ trực tuyến cung cấp hướng dẫn về các tùy chọn API cho thiết kế liên kết.
Cách mở Python và cài đặt gói API
Tôi sử dụng Pycharm, công cụ này mô tả tất cả các bước. Cách thực hiện tương tự với các công cụ khác. Mở Python và tạo Dự án mới.
Cài đặt gói " ideastatica_connection_api". Bắt đầu bằng cách mở terminal và nhập "pip install ideastatica_connection_api". Khi thực hiện lệnh này, thư viện API sẽ được cài đặt.
"pip install ideastatica_connection_api" - áp dụng cho phiên bản IDEA StatiCa mới nhất. Nếu bạn sử dụng các phiên bản cũ hơn, bạn cần chỉ định chính xác phiên bản để gọi thư viện API phù hợp.
(Ví dụ: "pip install ideastatica_connection_api==25.1.1.923" )
Các bước nêu trên là bắt buộc và phải được thực hiện đúng theo thứ tự. Nếu không, API sẽ không hoạt động đúng cách.
Mở dự án trong ứng dụng máy tính để bàn
Mục tiêu là điều khiển mô phỏng và đầu ra thông qua giao diện Python và đọc kết quả trực tiếp trong console.
Mở liên kết nối và chạy tính toán cho LE1 để lấy kết quả. Như bạn có thể thấy, toàn bộ tập hợp các kiểm tra đều đạt. Bạn có thể tiến hành sang Python.
Script Python
Nhập các gói sẽ cho phép sử dụng tính toán và liên kết với URL localhost.
Mã nguồn:
## Link with baseUrl
import ideastatica_connection_api.connection_api_service_attacher as connection_api_service_attacher
Cấu hình ghi nhật ký thông qua biến "baseUrl," sẽ kết nối với localhost của bạn. Ở bước thứ hai, ghép nối đường dẫn tuyệt đối của tệp IDEA StatiCa Connection của bạn.
Mã nguồn:
## Configure logging
baseUrl = "http://localhost:5000"
## Absolute path into folder with your python script and connection module
project_file_path = r"C:\Users\LukasJuricek\Desktop\API_IDEA\Splice.ideaCon"
print(project_file_path)
Ghép nối client với dịch vụ đang chạy (1). Sử dụng khối try/except - khi khối try phát sinh lỗi, khối except sẽ được thực thi. Trong giai đoạn đầu, cần mở dự án (2) và tìm ID dự án của bạn, ID này là duy nhất cho mỗi dự án IDEA StatiCa (3). Khi chạy script, bạn có thể đọc đường dẫn được in ra cùng với ID duy nhất (4).
Mã nguồn:
with connection_api_service_attacher.ConnectionApiServiceAttacher(baseUrl).create_api_client() as api_client:
try:
## Open the project
openProject = api_client.project.open_project_from_filepath(project_file_path)
## Unique project ID that provide the control over the model
projectId = api_client.project.active_project_id
print(projectId)
Trích xuất "connection_ID" để xác định liên kết được tính toán (1). Chạy mô phỏng với biến "calculation_run," cần hai tham số bắt buộc được nêu trong ngoặc (2). Khi mô phỏng hoàn thành, bạn sẽ thấy ID liên kết và thông tin cho biết phân tích của bạn đã hoàn tất (3).
Mã nguồn:
## Opening project that will be calculated
connection = openProject.connections[0]
print(connection)
connection_ID = [connection.id]
## Assigning connection ID
calculation_run = api_client.calculation.calculate(
projectId,
connection_ID
)
print('Finished')
Trong bước cuối cùng, bạn tìm hiểu cách in kết quả (1) và cách lặp qua tất cả các kiểm tra hệ số sử dụng (2) được hiển thị tiêu chuẩn trên màn hình máy tính để bàn (3).
Mã nguồn:
## Postprocessing - extract the unity check of connection
Results = calculation_run[0].result_summary
## Loop over all unity checks like plates, bolts, welds
for results in Results:
print(results.unity_check_message)
except Exception as e:
print("Operation failed : %s\n" % e)
Kết luận
Bạn đã có kinh nghiệm sử dụng API cho thiết kế liên kết. Bạn đã học được những công cụ cần cài đặt, cách kết nối dịch vụ REST API và cách xử lý mã Python để lấy kết quả.