Tutoriale

Cum să începi cu API - Noțiuni de bază 01

Steel

Connection

Acest articol este disponibil și în:

Tradus de AI din engleză

Scopul acestui tutorial este de a oferi o explicație de bază despre cum să începi cu API, să deschizi primul tău proiect, să rulezi simularea și să afișezi rezultatele în consolă. Această parte ar trebui să fie o condiție prealabilă înainte de a trece la următoarea parte a cursului tău.

Ce este API (Interfața de programare a aplicațiilor)

Un set de reguli și protocoale care permit diferitelor aplicații software să comunice între ele. Definește modul în care cererile și răspunsurile trebuie structurate, permițând dezvoltatorilor să utilizeze funcții sau servicii predefinite fără a înțelege funcționarea lor internă.

REST API în IDEA StatiCa Connection - este un serviciu web găzduit local care urmează principiile REST, permițând sistemelor să comunice folosind metode HTTP standard pentru a efectua operații asupra resurselor, reprezentate de obicei în format JSON.

Resurse și GITHUB

Sursa exemplelor existente și predefinite este disponibilă pe GitHub-ul nostru:

https://github.com/idea-statica/ideastatica-public/tree/main/src/api-sdks/connection-api/clients/python/examples

Cum să începi

Tutorialul va fi prezentat în combinație cu limbajul de programare Python. Poți descărca cea mai recentă versiune aici. Poți utiliza multe Medii de Dezvoltare Integrate (IDE) ca instrumente pentru codare eficientă, depanare și testare. Iată câteva opțiuni:

Cum să rulezi API

Lansatorul API poate fi găsit în folderul unde este stocată cea mai recentă versiune a IDEA StatiCa. Rulează pur și simplu fișierul executabil.

Dacă rulezi „IdeaStatiCa.ConnectionRestApi.exe", se va deschide CMD (Command Prompt) și vei putea vedea localhost-ul tău și deschide aplicația Swagger, care îți permite să vizualizezi structura codului pentru controlul API. Apasă Control + Butonul Stâng al Mouse-ului pentru a deschide Swagger.

Swagger în modul online îți oferă un ghid despre opțiunile API pentru proiectarea îmbinărilor.

Cum să deschizi Python și să instalezi pachetul API

Utilizez PyCharm, care descrie toți pașii. Funcționează în același mod cu celelalte instrumente. Deschide Python și creează un Proiect Nou.

Instalează pachetul „ ideastatica_connection_api". Începe prin deschiderea terminalului și scrie „pip install ideastatica_connection_api". Dacă execuți această comandă, biblioteca pentru API va fi instalată.

„pip install ideastatica_connection_api" - funcționează pentru cea mai recentă versiune a IDEA StatiCa. Dacă ai versiuni mai vechi, trebuie să specifici exact versiunea pentru a apela biblioteca API corespunzătoare.

(De exemplu: „pip install ideastatica_connection_api==25.1.1.923" )

Pașii menționați anterior sunt obligatorii și trebuie urmați în mod corespunzător. În caz contrar, API nu va funcționa adecvat.

Deschide un proiect în aplicația desktop

Scopul va fi de a controla simularea și ieșirea prin interfața Python și de a citi rezultatele direct în consolă.

Deschide îmbinarea de eclisare și rulează calculul pentru LE1 și obține rezultatele. Poți observa că întregul set de verificări este satisfăcut. Poți continua cu Python.

Script Python

Importă pachetele care vor permite utilizarea calculului și legătura cu URL-ul localhost.

Cod sursă:

## Link with baseUrl import ideastatica_connection_api.connection_api_service_attacher as connection_api_service_attacher

Configurează jurnalizarea prin variabila „baseUrl", care va prelua localhost-ul tău. În al doilea pas, asociază calea absolută a fișierului tău IDEA StatiCa Connection.

Cod sursă:

## 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)

Asociază clientul cu un serviciu deja în execuție (1). Utilizează blocul try/except - dacă blocul try generează o eroare, blocul except va fi executat. În prima fază este necesar să deschizi proiectul (2) și să găsești ID-ul proiectului tău, care este unic pentru fiecare proiect IDEA StatiCa (3). Dacă rulezi scriptul, poți citi calea afișată + ID-ul unic (4).

Cod sursă:

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)

Extrage „connection_ID" care va identifica îmbinarea ce urmează a fi calculată (1). Rulează simularea cu variabila „calculation_run", care necesită doi parametri obligatorii specificați în paranteze (2). Dacă simularea se finalizează, vei vedea ID-ul îmbinării și informația că analiza a fost finalizată cu succes (3).

Cod sursă:

## 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')

În etapa finală, explorezi cum să afișezi rezultatele (1) și cum să iterezi peste toate verificările de grad de utilizare (2) care sunt afișate în mod standard pe desktop (3).

Cod sursă:

## 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)

Concluzie

Ai dobândit experiență cu API pentru proiectarea îmbinărilor. Ai învățat ce instrumente trebuie instalate, cum să conectezi serviciul REST API și cum să utilizezi codul Python pentru a obține rezultatele.