EndpointRow

Domain · API Doc

Tek bir endpoint satırı — HTTP metod rozeti, path ve özet. Tıklandığında OperationPanel açılır.

GET and POST rows

Preview

GET /products List products

POST /products Create product

Code

<%- include('modules/domain/api-doc/EndpointRow', {
  path: '/products',
  operation: {
    operationId: 'list-products',
    operationKey: 'list-products',
    method: 'GET',
    summary: 'List products',
    security: [{ BearerAuth: [] }],
    parameters: [],
    responses: [],
  }
}) %>

Source modules/domain/api-doc/EndpointRow.ejs

<%
  var _operation  = locals.operation  || {};
  var _path       = locals.path       || '';
  var _defaultOpen = locals.defaultOpen || false;

  var hasSecurity  = _operation.security && _operation.security.length > 0;
  var isDeprecated = !!_operation.deprecated;
%>

   class="group">
    

      <%- include('./HttpMethodBadge', { method: _operation.method || 'GET' }) %>

      <%= _path %>

      
        <% if (_operation.summary) { %>
          <%= _operation.summary %>
        <% } %>
        <% if (hasSecurity) { %>
          
        <% } %>
        <% if (isDeprecated) { %>
          
        <% } %>
        
      
    

    <%- include('./OperationPanel', { operation: _operation, className: 'rounded-none border-0' }) %>