= Metadata API

:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:page-partial:

The metadata APIs provide access to the framework's internal metamodel.
These are generally of use to support development-time activities, for example creating custom UIs through Swagger.


.Metadata API
[cols="2m,4a",options="header"]
|===

|API
|Description


|xref:refguide:applib:index/services/appfeat/ApplicationFeatureRepository.adoc[ApplicationFeatureRepository] & xref:refguide:applib:index/services/appfeatui/ApplicationFeatureMenu.adoc[ApplicationFeatureMenu]

|Provides access to string representations of the features (package, class, class members) of the domain classes within the metamodel.


|xref:refguide:applib:index/services/layout/LayoutService.adoc[LayoutService] &
xref:refguide:applib:index/services/layout/LayoutServiceMenu.adoc[LayoutServiceMenu]
|Use to obtain the resolved `Xxx.layout.xml` for a class, and the top-level `menubars.layout.xml` files.


|xref:refguide:applib:index/services/metamodel/MetaModelService.adoc[MetaModelService] & xref:refguide:applib:index/services/metamodel/MetaModelServiceMenu.adoc[MetaModelServiceMenu]
|Access to certain information from the Apache Causeway metamodel.


|xref:refguide:applib:index/services/sitemap/SitemapService.adoc[SitemapService] & xref:refguide:applib:index/services/sitemap/SitemapServiceMenu.adoc[SitemapServiceMenu]
|Access to a downloadable site map of the application's features, as an AsciiDoc document.

The intention is to use this as the basis for a user guide or to develop a manual regression test plan.


|xref:refguide:applib:index/services/swagger/SwaggerService.adoc[SwaggerService]
|Exports link:http://swagger.io/[Swagger] spec files, eg to generate link:http://swagger.io/swagger-codegen/[client-side stubs] for use in a custom REST client.



|===


