Liferay DXPによって公開されるすべてのAPIはliferayinc SwaggerHub organizationで利用できます。
Liferay DXPのヘッドレスAPIは、以下の異なる2つのユースケースに分類されます。
- コンテンツの配信（配信API）
- コンテンツの運用と管理（管理API）
利用可能なAPIは、すべてこの分類方法で分けられます。
ヘッドレス配信
以下の表では、ヘッドレス配信に含まれているAPIをまとめています。2番目の列は、APIがマップするLiferay DXPの内部モデルを示していることに注意してください。
| API | 内部モデル |
|---|---|
BlogPosting | BlogsEntry |
BlogPostingImage | DLFileEntry (BlogsEntryと関連) |
Comment | DiscussionComment |
ContentDocument | DLFileEntry (JournalArticleと関連) |
ContentSet | AssetListEntry |
ContentStructure | DDMStructure |
Document | DLFileEntry |
DocumentFolder | Folder |
KnowledgeBaseArticle | KBArticle |
KnowledgeBaseAttachment | FileEntry (KBArticleと関連) |
KnowledgeBaseFolder | KBFolder |
MessageBoardAttachment | FileEntry (MBMessageと関連) |
MessageBoardMessage | MBMessage |
MessageBoardSection | MBCategory |
MessageBoardThread | MBThread |
Rating | RatingsEntry |
StructuredContent | JournalArticle |
StructuredContentFolder | JournalFolder |
ヘッドレス管理
ヘッドレス管理APIがいくつかあり、それぞれに独自のAPIセットが含まれています。以下の表では、これらAPIと各APIがマップするLiferay DXPの内部モデルをまとめています。
Headless Admin Userには、ユーザーと組織に関する情報を取得および管理するために以下のAPIが含まれています。
| API | 内部モデル |
|---|---|
EmailAddress | なし |
Organization | なし |
Phone | なし |
PostalAddress | Address |
Role | なし |
Segment | SegmentEntry |
SegmentUser | なし |
SiteBrief | なし |
UserAccount | User |
WebUrl | WebSite |
Headless Admin Taxonomyには、アセットカテゴリ、アセットボキャブラリ、およびアセットタグを管理するために、以下のAPIが含まれています。
| API | 内部モデル |
|---|---|
Keyword | AssetTag |
TaxonomyCategory | AssetCategory |
TaxonomyVocabulary | AssetVocabulary |
Headless Admin Workflowには、ワークフローを移行するためのAPIが含まれています。