如何在Mendix中发布一个REST Service

于 2021-08-09 10:31:25 发布
阅读量1k 收藏 6
点赞数 1
文章标签： restful mendix 低代码 低代码开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Mendix/article/details/119531564
版权

目录

介绍（Introduction）

REST是什么？

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。 他在论文中提到：“我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件架构设计，得到一个功能强、性能好、适宜通信的架构。REST指的是一组架构约束条件和原则。” 如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

REST本身并没有创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力， 更好地使用现有Web标准中的一些准则和约束。虽然REST本身受Web技术的影响很深， 但是理论上REST架构风格并不是绑定在HTTP上，只不过目前HTTP是唯一与REST相关的实例。 所以我们这里描述的REST也是通过HTTP实现的REST。

Published REST Service

Published REST Service：Mendix Studio Pro中的Published REST Service功能会通过REST标准，展示你的Entities（实体）和 Microflow（微流）给其他应用App使用。
在这里插入图片描述

一般属性

Service Name（服务名称）

Service Name 服务名称是用来识别应用中的服务。它还显示在 OpenAPI (Swagger) documentation page。
当服务最初创建时，服务名称用于创建服务的默认位置。如果服务名称包含任何空格或特殊字符，则它们将被服务位置中的字符“_”替换。

Version (版本)

Version （版本）在 OpenAPI (Swagger) documentation page上展示版本信息。在Version 版本中，您可以设置任何的字符串String。建议符合 semantic versioning scheme。
默认 Version 版本信息设置为“1.0.0”。

Location 位置信息

Location 展示URL在一个Service 服务被访问时。
默认Location位置信息由 Service Name (服务名称)和"v1"到"rest/"前缀建立起来。
在URL中 Service Name 服务名称中的空格和任何其他的特殊字符都会被剥离成“_”。

示例：

http//localhost:8080/rest/my_service_name/v1

你可以改变默认的Location 位置信息-几乎所有合格的URL。

Reserved Prefixes 保留的前缀

以下URL前缀是不允许被使用在Location信息中的：

ws/
ws-doc/
rest-doc/
odata/
odata-doc/
api-doc/
xas/
p/
reload/

当你的应用在运行的时候，你可以点击这个Location 去打开交互文档页面。

Public Documentation 公共文档

公共文档使用服务文档 OpenAPI 2.0 (Swagger) Documentation,你可以使用对于富文本的版本 GitHub-flavored markdown

导出swagger.json

为了保存一个服务的 OpenAPI (Swagger) documentation page在你的机器上，右键点击这个服务在App Explorer 并且选择Export Swagger.json(或者只点击这个Export Swagger.json 按钮，依赖于你的Studio Pro 的版本)。 这是一个机器可读的文件在OpenAPI 2.0 file format。大部分的API 工具支持这个格式。
当应用运行时，这个文件 在 /rest-doc/servicename/swagger.json.

Security 安全

需要身份认证

选择客户端是否需要身份认证。

身份认证的方式

如果需要身份认证，你可以按照你的习惯选择身份认证的方式。

  • 选择Username 和Password 的方式让客户端进行身份认证，在Authorization Header中（这种是基础的身份认证的方式）。
  • 选择激活Session 会话来自于JavaScript 在你当前应用中。
    – 用户一登录到浏览器，JavaScript在你的App中访问REST Service 使用当前用户的Session。
    – Offline-first应用不能使用激活Session的身份认证，因为他们没有会话激活在应用运行时。
    – 了防止跨站点请求伪造，需要在每个请求上设置标题，例如X-Csrf-Token
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "http://mysite/rest/myservice/myresource", false);
xmlHttp.setRequestHeader("X-Csrf-Token", mx.session.getConfig("csrftoken"));
xmlHttp.send(null);
  • 选择自定义使用微流进行身份验证。每次用户想要访问资源时，此微流都会被调用。
    检查多个身份验证方法，让服务尝试其中的每一个。它将首先尝试自定义身份验证，然后尝试用户名和密码，然后进行活动会话。有关详细信息，请参阅已发布的 REST 路由。

微流

指定用于自定义身份验证的微流。

选择参数，查看传递到身份验证微流的参数列表。在该窗口中，您可以指示身份验证微流的参数是来自请求头还是来自查询字符串。

微流可能以Http 请求为参数，以便检查传入请求。

微流也可能以响应响应为参数。当微流将此响应的状态代码设置为其他200时，此值将被返回，并且操作将不会执行。在这种情况下，响应上设置的任何标题也会返回。

身份验证微流应返回用户。

认证微流有三种可能的结果：

  • 当 Http 响应参数的状态代码设置为其他200时，则返回此值，并且不会执行操作
  • 否则，当生成的用户不是空的时，操作在该用户的上下文中执行
  • 否则，当生成的用户为空时，将尝试下一种身份验证方法。如果没有其他身份验证方法，结果为404 未找到。

允许角色

允许的角色定义了用户必须能够访问服务的模块角色。此选项仅在"需要身份验证"设置为"是"时可用。

网络服务用户无法访问 REST 服务。

启用 CORS

当您的服务需要在您自己的网站之外可用时，请选中此框。

单击"设置"按钮以更详细地指定此访问（例如，允许哪些网站访问该服务）。

资源

一个REST Service 暴露 一批资源。在这个资源中你可以定义ET, PUT, POST, PATCH, DELETE, HEAD and OPTIONS操作。
你可以托一个Entity或者信息的定义在列表在[生成一个完整的资源]（https://docs.mendix.com/refguide/generate-rest-resource）。

操作

当你选择了一个资源后，你看到这个操作对于那个你选择的资源。
在这里插入图片描述

如何发布一个REST Service

介绍

Mendix Studio pro 允许您发布REST Web Service。
本篇主要介绍如何使用Mendix Studio Pro 发布一个Get 操作的Published REST Service.
主要做的事情是，创建一个Published REST Service和以JSON或者XML的格式返回结果。

前期准备工作

在开始所有操作之前，请确保下载了Mendix Studio Pro。

配置样例 Project

创建一个空的Mendix Project后，您需要操作一下几个步骤：

  1. 重命名MyFirstModule 为RESTExample。
  2. 打开RESTExample中的Domain model。
  3. 创建Entities 按照图中的属性名称设置并给予与图中相同的关联关系。

在这里插入图片描述
4. 您需要右键点击OrderItem 或Order Entity选择Generate Overview pages.
在这里插入图片描述
5.将Overview Page 关联到Navigation 导航，然后运行项目添加一些数据。

发布REST Service

1.在 App Explorer, 右键点击 RESTExample module 并且选择Add > Other > Message Definitions:
2.在Add Message Definition 对话框中输入MD_Orders 作为 这个的名称定义。
3. 这个消息的定义已经打开了，你需要去选择用于MD_Orders 定义的Entity。为了做这个操作，选择Add 并且在对话框中，点击Select，然后选择Order Entity对于这个List。
在这里插入图片描述
4.在选择完Order Entity，这个对话框中的Structure 结构部分填充只有Order 对象被选中。
4. 选择Order ID 和Customer 属性。
5. 展开OrderItem_Order关联并且选择Product和Quantity 属性。
在这里插入图片描述
6. 点击OK来关闭对话框。
7. 关闭message definition 并且确保保存定义，如果弹出对话框询问是否保存时。

配置REST Service

1.在App Explorer，右键点击RESTExample Module ，并且选择 Add > Other > Published REST Service在这里插入图片描述
2. 输入PRS_OrderService 为的REST Service的名称。
3. 添加一个新的资源到你的服务通过点击Add，并且输入GetOrderByID 为Resource name:
在这里插入图片描述选择Ok 来关闭对话框。

  1. 添加一个operation 操作到你的资源中通过点击Add在Operations for resource 选项中。
  2. 在operation 操作对话框，输入**{OrderID}**在Operation Path ，这将允许REST Service被调用通过指定OrderID在URL中在Example location的输入框中。在这里插入图片描述
  3. 在相同的对话框，点击Microflow的Select。由于你没有创建过Microflow 微流对于这个操作，选择RESTExample Module 在对话框中然后点击New 来创建一个新的微流。输入PRS_GetGetOrderByID 作为新Microflow微流的名称。在这里插入图片描述
  4. 点击show 来开始编辑这个新建的微流。
  5. 检查2个参数HttpRequest 和OrderID是否存在，若没有请自行添加。
  6. 添加一个Action 对于这个微流来覆盖OrderID 变量（String）为一个Integer 变量。
    查询OrderID（autonumber）需要做这个操作。
    在这里插入图片描述
  7. 添加第二个Activity 对于这个微流来获得Order 基于OrderID。这个Retrieve操作只返回1个Order。
  8. 在App Explorer，右键点击 RESTExample module并且选择Add other > Export Mapping 来添加一个新的Mapping 映射命名为EM_ExportOrder
  9. 在Select schema elements for export mapping对话框中，选择Message definition选项，然后选择之前创建的MD_Orders映射通过Select按钮。
    在这里插入图片描述
    确保选择所有的展示出的属性，点击OK
  10. 在Export Mapping ，映射Objects到相同Objects 来自Domain model.双击右边的Order然后选择相对应的Entity。
    在这里插入图片描述
  11. 现在返回 PRS_GetGetOrderByID microflow 微流并且添加一个 Export with mapping 的activity.
  12. 在Mapping区域选择在第11步创建的 mapping . 对于 Parameter参数 field, 选择 Order object 对象retrieved获取于 database 通过retrieve action 在 microflow.
  13. 选择JSON 作为result结果, 并且存储output 作为一个 String variable变量. 输入 Order_JSON作为variable变量名称.
    在这里插入图片描述
    17添加一个Activity在微流中来创建一个HttpResponse的对象。
    在这里插入图片描述
    StatusCode：200
    content：mapped to the exported JSON from step 16.
    HttpVersion： ‘HTTP/1.1’.
  14. 添加一个Activity在微流中，用来创建请求头。在这里插入图片描述
    Key： ‘Content-Type’
    Value： ‘application/json’(or ‘application/xml’ if your response contains XML rather than JSON).
    Set the System.HttpHeaders association to your HTTP response.
  15. 打开End Activity 在你的微流中选择$NewHttpResponse 作为返回值。
    在这里插入图片描述

浏览您的应用

  1. 运行您的App打开您的浏览器，输入
http://localhost:8080/rest-doc/

  1. 您会看到图中页面
    在这里插入图片描述
    3.点击 PRS_OrderService查看：
    在这里插入图片描述

  2. 点击Get 然后点击try it out

  3. 填入OrderID点击Execute：
    在这里插入图片描述
    5.执行request返回这个结果在 Response body：在这里插入图片描述
    在这里插入图片描述

在这里插入图片描述

更多信息，请访问以下链接：

Mendix官网：https://www.mendix.com/zh/

Mendix中国论坛：https://forum.mendix.tencent-cloud.com/

Mendix行业解决方案：https://solutions.mendix.com/

Mendix平台指南：https://www.mendix.com/evaluation-guide/

Mendix动画展示：https://www.mendix.com/demos/

感谢阅读！

Mendix
关注
博客
与 Magic Quadrant™ 低代码领导者一起满足您的开发需求
11-11 1179
Mendix 连续八年被评为领导者的原因之一，包括我们连续第二年在执行能力方面名列前茅。
博客
Mendix荣膺Forrester低代码开发平台“领导者”称号，并在“现有服务”类别中排名第一
05-18 912
Forrester报告指出：“Mendix继续引领低代码市场发展，其大部分功能极为出色。” 此次共对14家低代码供应商进行了严格评估。企业低代码应用开发全球领导者Mendix, a Siemens business今日宣布，Mendix在《Forrester Wave™：面向自动化和数字化专业人员的低代码开发平台，2021年第二季度》报告中被评为领导者。Forrester的此份报告重点关注数字化流程自动化与低代码的融合。由于新冠疫情危机增加了对流程自动化的需求，各类开发人员正在推动有史以..
博客
客户案例｜借力 Mendix 低代码，加速博世汽车电子数字化转型
03-25 968
主要问题是针对需求的理解可视化，传统开发模式下，往往需要业务部门耗费很长的时间攥写非常详细的 PRD 文档，这个工作量巨大，且可能会持续数月之久，开发团队拿到这些需求后开始动手开发，直至开发团队完成系统的上线，这中间又需要历时数月，等到业务部门看到自己当初需求的系统时，往往可能已是半年之后，在这个时候业务部门的流程很大概率已经发生了微调或变化。他们发现造成前面现象的主要原因在于，像博世这样的全球企业，有严格的数据保护规定，这些文件存储都是需要加密的，根据软件定义的数据等级，如果机密性较高，就需要加密。
博客
基于西门子Insights Hub和私有化DeepSeek推理模型的智能生产助理
03-14 801
目前市面上的通用大模型很多，如OpenAI的GPT-4o，Google DeepMind开发的Gemini 1.5 Pro，Meta AI的LLaMA系列，DeepSeek-R1 , 阿里的Qwen2.5等，企业根据自身技术栈等原因会有不同的选择。作为一个数据驱动的综合物联网平台，Insights Hub保持了充分的开放性，客户可以轻松接入自己的大模型，利用Insights Hub提供的时序数据及工业语料丰富自己的大模型能力，同时自建智能助理（AI Agent）提升生产智能化水平。
博客
相得益彰，Mendix AI connector 秒连DeepSeek ，实现研发制造域场景
02-13 968
Mendix 于近期发布的 GenAI 万能连接器，目前已支持 DeepSeek 与 Mendix 的连接融合。
博客
客户案例｜大众安徽：低代码加速智能工厂创新
01-07 803
通过我们和 IT&D 团队的努力，大众安徽定义了清晰的接口，明确了职责分工，使 Mendix 的应用范围远超传统工具。大众安徽通过将业务人员纳入 MENDIX 项目的各个环节，如需求梳理，调研，系统设计，甚至开发，可以让业务人员真正感受到一个数字化转型项目是如何发起，如何启动，如何落地的。在过去积累的现场管理方案的支持下，仅用三个月时间，便逐步开发了四个应用，涉及车间领域的现场管理和质量控制、整车问题追踪和升级、白领区域工作效率优化等，这些应用落地实施后，应用相关工作效率可以提高 20% – 40%。
博客
Mendix 10.17 发布 – 跨越语言界限，打造全球利器
12-19 1040
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。在“帮助”下的支持工具菜单中，我们添加了一项新功能，您可以在其中提供有关您遇到的问题的更多信息。作为一项新的公开测试版功能，现在可以从首选项中更改 Studio Pro 的语言，之后 Studio Pro 的界面将更改为您选择的语言。在过去几个月中，我们添加了一系列令人兴奋的新功能，并简化了菜单，以帮助您准确找到所需的内容。迁移后，您将收到完整的 SVN 备份，以供审核。
博客
Mendix 创客访谈录｜Mendix 助力西门子原生数字化工厂精益高效
11-18 955
除去系统功能对业务的帮助来讲，更多的带来是意识形态上的一些转变，过往的软件开发完全依赖 IT 部门，现在 Mendix 低代码带来了一种自己进行开发的可能性，业务部门在实践中更加了解软件开发，具备了一定的编程思维，提出的需求也越来越完备高质量，并且会在第一时间思考自己通过低代码完成的可能性。相较于传统开发模式，Mendix 基于低代码的特点以及本身的优势，使业务部门的同事有机会亲自动手进行软件开发，一定程度上缓解了 IT 开发资源的压力，也降低了开发的成本与周期；大家好，我是向宇轩。
博客
Mendix 10.15 版——整个软件开发生命周期的福音
10-28 1050
Maia Best Practice Recommender是一款智能虚拟协同开发者机器人，它通过根据Mendix开发最佳实践检查您的应用模型来帮助您提高应用的性能。它会显示错误、警告、弃用和建议，以帮助您优化Mendix应用。它类似于高代码世界中的静态代码分析。
博客
Mendix 创客访谈录｜平台造平台真的可以吗？– 记西门子自由流业务系统的实战
10-09 962
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。对于开发者来说在Studio Pro中直接下载模块或组建即可直接使用，大大提高开发效率，同时Mendix也提供友好的开发接口，支持开发者自定义组件和模块，开发过程更加灵活。Mendix提供了直观的可视化工具，支持复杂的应用自定义开发。使用Mendix Pro IDE的环境，其布局清晰，操作流畅，开发速度快，可灵活进行自定义，文档完善，支持本地开发及一键发布应用。
博客
软件开发人员利用Mendix推动GenAI战略
09-24 835
企业软件供应商应该谨慎对待某些生成式人工智能（AI）工具对数据、流程和文化造成的风险。然而，推迟实施AI战略的风险更大。随着软件开发人员学习如何使用GenAI简化编码流程，他们的产出速度和质量将大幅提高，从而将竞争对手甩在身后。20年来，Mendix低代码平台提高了开发人员的生产力。秘诀之一就是缩短新技术实施的价值实现时间。Mendix已经推出了创新功能，可以使用GenAI自动化和增强软件开发，而其他开发平台仍处于反复试验阶段。
博客
Mendix 10.14 版 – 新版本上线及新功能点介绍
09-10 1004
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。我们将为您预先填写所有所需信息，只需单击两次，您就可以与同行分享您的最新成就。这不仅可以节省时间和资源，还可以最大限度地降低人为错误的风险，并确保在您的IdP中实施的访问控制策略在您的B2E Mendix应用程序组合中一致执行。在Studio Pro中同时启用了新系统文本编辑器和AI翻译的用户，可以自动为您应用中的系统文本生成任何语言的翻译，从而减少设置这些翻译所需的时间。
博客
Mendix 创客访谈录｜Mendix赋能汽车零部件行业：重塑架构，加速实践与数字化转型
09-04 1873
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。该应用通过集成SAP中的设备主数据、工单和产量信息等，以及Zeno能源系统中设备的能耗数据，充分考虑了生产流程的复杂性、库存与物流的高效管理、严格的质量追溯体系以及产品种类的多样性等特点。陶冶：Mendix的成熟度和稳定性我认为是低代码开发平台中遥遥领先的，庞大的用户社区和在线资源代表初学者可以轻松上手，加上全面的开发工具链和集成能力，让高级开发者可以迅速构建出高质量应用。
博客
Mendix 创客访谈录｜拥有强大社群支持的低代码开发平台
08-20 944
相比较传统的开发，我觉得Mendix最主要的优势是极大的降低了软件开发的门槛，以前软件需要非常专业的人员来进行代码编写和开发的，但是Mendix仅仅只需要一个月左右的培训，一般人员也就能进行简单的开发了，在专业人员的指导下，也能进行比较深入的开发，对于工厂来说，可以在资源有限的情况下，能够及时并且有效的对接需求部门的要求并且实现它。当然会了，我相信低代码开发会是将来的在项目开发中的主流趋势，而Mendix又是这项技术的领头羊，随着使用人群的扩大，它的生态会越来越完善，今后Mendix的便利性会越来越高。
博客
如何用不到一分钟的时间将Excel电子表格转换为应用程序
08-13 2980
Mendix让企业能够以前所未有的速度构建应用程序、促进IT团队与业务专家之间开展有意义的协作，并帮助IT团队保持对整个应用程序环境的控制。作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。您的团队可能会花费一半宝贵的时间来弄清楚他们是否在查看最新数据，另一半时间在工作表之间复制数据以从不同人的个人版本中收集所有相关内容。不再有充斥的收件箱。也许最重要的是，这让您能够对团队、部门和公司的运营方式实施持久和可持续的改进。
博客
Mendix 创客访谈录｜更易集成多系统的定制化开发平台
08-06 403
来自台湾宝岛合作伙伴的使用心得~
博客
Mendix 创客访谈录｜Mendix 如何化解工业企业数字化转型的复杂性
08-05 1121
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。技术成熟度和企业级支持；在我的职业生涯中，参与了多个关键项目的开发，涵盖了制造执行系统（MES）的实施，以及工业物联网（IIoT）和项目质量管理的应用研发。截至目前，我和我的团队利用Mendix低代码平台开发了一系列应用，这些应用不仅服务于我们部门内部的需求，也支持了公司其他业务部门的工作。在使用Mendix进行开发的过程中，我和我的团队确实发现了一些可以优化的方面。
博客
我尝试了新的 OpenAI 连接器，真太棒了！
07-04 1023
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。我的设置为“https://api.openai.com/v1/”，按照表单中的示例建议。用户被分配“用户”，模型被分配“助手”，任何系统提示都被分配“系统”。接下来，运行您的应用程序，以管理员用户身份登录（MxAdmin 适用于本地环境），然后导航到 OpenAI 的配置概述。它仅仅是请求的持有者。在我的主页“Home_Web”上，我有一个简单的聊天窗口供用户输入他们的消息。
博客
Mendix 创客访谈录｜Mendix开发制造业客户复杂应用的强大实力
06-27 682
原因在于之前使用的这些产品，没有办法支持和传统代码的结合，而且原厂提供的标准组件少的可怜，遇到一丁点的克制化需求，就很难或者完全没有办法实现。对于Mendix的每个成功的应用开发我们都引以为傲，关键是Mendix的开发速度相对较快，另外代码的bug率相对纯代码开发有明显的优势。大家好，我是郑立，目前担任Eviden中国低代码服务团队的负责人，Mendix是Eviden中国在低代码领域的最重要的合作伙伴，目前我们在多个制造业客户中推广和实施Mendix低代码项目，并获得了客户的认可。
博客
Mendix 创客访谈录｜医疗设备领域的数字化转型利器
06-19 845
作为一直被领先的行业分析师视为“领军者和远见者”的低代码平台，Mendix是云原生的、开放的、可扩展的、敏捷的，并且经过实践验证。综上所述，使用Mendix Pro IDE开发应用真是一次非常棒的体验，它不仅提高了我的开发效率，也极大地支持了团队合作，对于需要快速迭代和创新的开发项目来说，这款工具无疑是极好的选择。我们公司是21年关注到西门子Mendix，21年主要是学习，到22的时候我们开始正式利用西门子Mendix开发我们内部的产品，说起来我们使用mendix已经有4年之久了。大家好，我叫尚衍亮。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值