ms-structural / ms-structural/femdesign-api

[🚀 FEM-Design API gRPC]

Open
#1,193 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
51
Forks
29
PR merge metrics
No merged PRs in 30d

Description

API Refactoring and Cross-Language Strategy

As outlined in issue #962 , the current API requires a substantial refactoring effort. Technical debt has been steadily accumulating, and without intervention, maintainability and scalability will soon become a significant risk.

Contrary to what was initially specified in the original case, we plan to ship a cross-language API tool. This decision is driven by multiple requests for a Python API, in addition to existing C# usage. Supporting multiple languages is therefore a strategic requirement rather than a nice-to-have.

To achieve this, we will adopt gRPC as the core API technology. gRPC enables the creation of a high-performance, scalable, and maintainable API, while naturally supporting cross-language clients. This approach positions our API to become best-in-class in terms of performance, long-term sustainability, and developer experience.

Informations related to the topic are visible in https://github.com/ms-structural/femdesign-api-2.0

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #962 and the related information in the femdesign-api-2.0 repository. The issue names no files, tests, or entry points, so first clarify the gRPC API scope, supported client languages, and concrete definition of done before implementation can begin.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, grpc, python
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.